io.deephaven.engine.util.LiveWidgetVisibilityProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-engine-table Show documentation

Engine Table: Implementation and closely-coupled utilities

There is a newer version: 0.37.1

Show newest version

/**
 * Copyright (c) 2016-2022 Deephaven Data Labs and Patent Pending
 */
package io.deephaven.engine.util;

/**
 * 
 * LiveWidgets may implement this interface to restrict the users who can see a particular widget.
 * 
 *
 * 
 * This interface only enables the widget developer to limit the users who may open the widget; it does not provide any
 * control over what users can see after the widget is opened. The widget itself is responsible for determining which
 * data should be presented to the user and applying any appropriate viewer permissions.
 * 
 *
 * 
 * If widgets do not implement this interface, they are visible to all users of the query.
 * 
 *
 * 
 * Unlike tables, limiting the visibility of one widget does not affect the visibility of other widgets.
 * 
 */
public interface LiveWidgetVisibilityProvider {
    /**
     * Provide a list of groups which may view this widget. null indicates that there are no viewing restrictions on
     * this widget.
     *
     * @return the list of groups which may view this widget, null for no restrictions
     */
    String[] getValidGroups();
}