UserGroupBean (Web API 2021)

All Superinterfaces:

EditableBean, EditableObjectBean, EnumWebPersistableState, ObjectBean, Persistable, RequestPersistable, Scrollable, Transformable, UserEntityBean, WebBean, WebComponent
```
public interface UserGroupBean
extends UserEntityBean, Scrollable
```
This interface represents a group user. Besides the basic funtionalities in UserEntityBean, it has the funtionalities of retrieving its children users and expand/collapse itself.

Since:

MicroStrategy Web 8.0.0

Field Summary
- 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
- Fields inherited from interface com.microstrategy.web.beans.UserEntityBean
  VIEWMODE_BROWSE, VIEWMODE_EDIT

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`UserEntitiesBean`	`getChildren()`	Returns the children collection.
`boolean`	`isExpanded()`	Returns whether current bean is expanded or not.
`void`	`setExpanded(boolean expanded)`	Expands or Collapses this bean.

Methods inherited from interface com.microstrategy.web.beans.EditableBean
delete, duplicate, InitAsNew, save

Methods inherited from interface com.microstrategy.web.beans.EditableObjectBean
getFolderId, isNew, saveAs, setFolderId, setIsNew

Methods inherited from interface com.microstrategy.web.beans.ObjectBean
getBlockBegin, getBlockCount, getDisplayName, getFlags, getLevel, getObjectID, getObjectInfo, getObjectName, getObjectType, getParentFolderBean, getParentFolderBean, getParentID, setBlockBegin, setBlockCount, setFlags, setLevel, setObjectID, setObjectInfo, setObjectName, setObjectType

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.UserEntityBean
getParentGroups, getPrivilegeCategories, getUserEntityObject, getViewMode, isGroup, refresh, setViewMode

Methods inherited from interface com.microstrategy.web.beans.WebBean
getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale

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
  - isExpanded
```
boolean isExpanded()
            throws WebBeanException
```
    Returns whether current bean is expanded or not.
    
    Returns:
    
    boolean true when this group bean is expanded. Otherwise, false returned.
    
    Throws:
    
    WebBeanException - Thrown if error occurs.
  - setExpanded
```
void setExpanded(boolean expanded)
          throws WebBeanException
```
    Expands or Collapses this bean.
    
    Parameters:
    
    expanded - boolean true passed to expand this bean, false to collapse this bean.
    
    Throws:
    
    WebBeanException - Thrown when error occurs.
  - getChildren
```
UserEntitiesBean getChildren()
                      throws WebBeanException
```
    Returns the children collection.
    
    Returns:
    
    UserEntitiesBean The collection of children.
    
    Throws:
    
    WebBeanException - Thrown when error occurs.