public interface

UserEntitiesBrowserBean

implements AppComponent RequestPersistable Scrollable
com.microstrategy.web.app.beans.UserEntitiesBrowserBean
Known Indirect Subclasses

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.objects.Scrollable
Public Methods
abstract void clearCurrentGroup()
Clears the user group being browsed and the available items.
abstract void clearSearch()
Clears the WebSearch object and the available items.
abstract UserEntitiesBean getAvailableItems()
Returns the available users or groups from one of the three sources: (1) all top level user groups; (2) a user group; or (3) search results.
abstract String getCurrentGroupID()
Returns the object ID of the user group which is being browsed.
abstract WebSearch getSearchObject()
Returns a WebSearch object from which the available items are obtained.
abstract boolean isSearchDefined()
Indicates whether the available items are obtained from a search.
abstract void setCurrentGroupID(String id)
Sets the object ID of the user group which is being browsed.
abstract void setTopLevelGroupsUserEntityBean(String key)
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent
From interface com.microstrategy.web.objects.Scrollable

Public Methods

public abstract void clearCurrentGroup ()

Clears the user group being browsed and the available items.

public abstract void clearSearch ()

Clears the WebSearch object and the available items.

public abstract UserEntitiesBean getAvailableItems ()

Returns the available users or groups from one of the three sources: (1) all top level user groups; (2) a user group; or (3) search results.

Returns
  • the available users or groups.

public abstract String getCurrentGroupID ()

Returns the object ID of the user group which is being browsed.

Returns
  • the user group object ID.

public abstract WebSearch getSearchObject ()

Returns a WebSearch object from which the available items are obtained.

Returns
  • a WebSearch object.

public abstract boolean isSearchDefined ()

Indicates whether the available items are obtained from a search.

Returns
  • true if the available items are ontained from a search.

public abstract void setCurrentGroupID (String id)

Sets the object ID of the user group which is being browsed.

Parameters
id the user group object ID.

public abstract void setTopLevelGroupsUserEntityBean (String key)