Package com.microstrategy.web.app.beans
Interface UserEntitiesSelectorBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,Persistable
,RequestPersistable
,Scrollable
,Transformable
,UserEntitiesBrowserBean
,WebComponent
public interface UserEntitiesSelectorBean extends UserEntitiesBrowserBean
The interfaceUserEntitiesSelectorBean
encapslute three types of sources to fetch users and groups: (1) all top level user groups, (2) parents or members of a particular user group, and (3) search result of users or groups.- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
SELECT_MEMBERS
Indicates to select the members of a particular user group.static int
SELECT_PARENTS
Indicates to select the parent groups of a particular user group.-
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 UserEntitiesBean
getSelectedItems()
Returns the selected users or groups from thetarget bean
.int
getSelectionType()
Returns the selection type, either parents or members.void
setSelectionType(int type)
Sets the selection type, either parents or members.-
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.app.beans.UserEntitiesBrowserBean
clearCurrentGroup, clearSearch, getAvailableItems, getCurrentGroupID, getSearchObject, isSearchDefined, setCurrentGroupID, setTopLevelGroupsUserEntityBean
-
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
-
-
-
-
Field Detail
-
SELECT_PARENTS
static final int SELECT_PARENTS
Indicates to select the parent groups of a particular user group.- See Also:
- Constant Field Values
-
SELECT_MEMBERS
static final int SELECT_MEMBERS
Indicates to select the members of a particular user group.- See Also:
- Constant Field Values
-
-
Method Detail
-
getSelectedItems
UserEntitiesBean getSelectedItems()
Returns the selected users or groups from thetarget bean
.- Returns:
- the selected users or groups.
- See Also:
WebComponent.getTargetBean()
-
getSelectionType
int getSelectionType()
Returns the selection type, either parents or members.- Returns:
- the selection type.
-
setSelectionType
void setSelectionType(int type)
Sets the selection type, either parents or members.- Parameters:
type
- the selection type.
-
-