UserEntitiesBrowserBean (Web API 2021)

All Superinterfaces:

AppComponent, EnumWebPersistableState, Persistable, RequestPersistable, Scrollable, Transformable, WebComponent

All Known Subinterfaces:

UserEntitiesSelectorBean
```
public interface UserEntitiesBrowserBean
extends AppComponent, RequestPersistable, Scrollable
```
Since:

MicroStrategy Web 9.0.0

Field Summary
- Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
  COMPONENT_POSITION_NOT_INITIALIZED
- Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
  BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
- Fields inherited from interface com.microstrategy.web.objects.Scrollable
  FIRST_BLOCK, NEXT_BLOCK, PREVIOUS_BLOCK

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clearCurrentGroup()`	Clears the user group being browsed and the available items.
`void`	`clearSearch()`	Clears the `WebSearch` object and the available items.
`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.
`java.lang.String`	`getCurrentGroupID()`	Returns the object ID of the user group which is being browsed.
`WebSearch`	`getSearchObject()`	Returns a `WebSearch` object from which the available items are obtained.
`boolean`	`isSearchDefined()`	Indicates whether the available items are obtained from a search.
`void`	`setCurrentGroupID(java.lang.String id)`	Sets the object ID of the user group which is being browsed.
`void`	`setTopLevelGroupsUserEntityBean(java.lang.String key)`

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.objects.Scrollable
getBlockPosition, getBlockSize, gotoBlock, hasNextBlock, hasPreviousBlock, setBlockSize

Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

- Method Detail
  - getAvailableItems
```
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.
  - getCurrentGroupID
```
java.lang.String getCurrentGroupID()
```
    Returns the object ID of the user group which is being browsed.
    
    Returns:
    
    the user group object ID.
  - setCurrentGroupID
```
void setCurrentGroupID(java.lang.String id)
```
    Sets the object ID of the user group which is being browsed.
    
    Parameters:
    
    id - the user group object ID.
  - clearCurrentGroup
```
void clearCurrentGroup()
```
    Clears the user group being browsed and the available items.
  - isSearchDefined
```
boolean isSearchDefined()
```
    Indicates whether the available items are obtained from a search.
    
    Returns:
    
    true if the available items are ontained from a search.
  - getSearchObject
```
WebSearch getSearchObject()
```
    Returns a WebSearch object from which the available items are obtained.
    
    Returns:
    
    a WebSearch object.
  - clearSearch
```
void clearSearch()
```
    Clears the WebSearch object and the available items.
  - setTopLevelGroupsUserEntityBean
```
void setTopLevelGroupsUserEntityBean(java.lang.String key)
```