Package com.microstrategy.web.beans

Interface UserEntityBean

All Superinterfaces:

EditableBean, EditableObjectBean, EnumWebPersistableState, ObjectBean, Persistable, RequestPersistable, Transformable, WebBean, WebComponent

All Known Subinterfaces:

UserBean, UserGroupBean

public interface UserEntityBean
extends EditableObjectBean

This is the base interface for both UserBean and UserGroupBean. It has all common funtionalities shared between UserBean and UserGroupBean.

Since:

MicroStrategy Web 8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	VIEWMODE_BROWSE	View mode of browsing.
static int	VIEWMODE_EDIT	View mode of editing.

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
UserEntitiesBean	getParentGroups()	Returns the collection of parent groups of this user.
WebPrivilegeCategories	getPrivilegeCategories()	Returns a set of categorized privileges for the current user.
WebUserEntity	getUserEntityObject()	Returns the WebUserEntity object, this bean refers to.
int	getViewMode()	Returns the view mode, a value of VIEWMODE_BROWSE or VIEWMODE_EDIT.
boolean	isGroup()	Returns whether this user is a group user.
void	refresh()	Refresh this user information from backend.
void	setViewMode(int mode)	Sets the view mode, a value of VIEWMODE_BROWSE or VIEWMODE_EDIT.

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.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.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

Field Detail

VIEWMODE_BROWSE

static final int VIEWMODE_BROWSE

View mode of browsing. In this mode, bean only need to populate the user's name, ID, and some basic information. It is not neccessary for the bean to populate the information about the privileges, security filters, authentication, etc. In this mode, the bean will assume no change made to the bean and only save limited information in the state, which is enough for it to re-populate the information from backend.

See Also:

Constant Field Values

VIEWMODE_EDIT

static final int VIEWMODE_EDIT

View mode of editing. In this mode, bean will populate all information relate to this user for editing. During the saving state, it will check whether the bean has been modified to decide how to save the state. Any change to the bean will be saved and restored later.

See Also:

Constant Field Values

Method Detail

getParentGroups

UserEntitiesBean getParentGroups()
                          throws WebBeanException

Returns the collection of parent groups of this user. If this user has not parent, this collection will be empty.

Returns:

UserEntitiesBean The collection of parent groups.

Throws:

WebBeanException - Thrown when error occurs.

isGroup

boolean isGroup()

Returns whether this user is a group user.

Returns:

boolean true if the user is a group user. Otherwise, it is a single user.

getViewMode

int getViewMode()

Returns the view mode, a value of VIEWMODE_BROWSE or VIEWMODE_EDIT. view mode will affect the way the bean to populat and to save the state.

Returns:

int The view mode.

setViewMode

void setViewMode(int mode)

Sets the view mode, a value of VIEWMODE_BROWSE or VIEWMODE_EDIT.

Parameters:

mode - int The new view mode.

See Also:

getViewMode()

getUserEntityObject

WebUserEntity getUserEntityObject()
                           throws WebBeanException

Returns the WebUserEntity object, this bean refers to.

Returns:

WebUserEntity The user object this bean refers to.

Throws:

WebBeanException - Thrown when error occurs.

refresh

void refresh()
      throws WebBeanException

Refresh this user information from backend. Group user will keep the expanded structure.

Specified by:

refresh in interface EditableBean

Throws:

WebBeanException - Thrown when error happens during refresh.

getPrivilegeCategories

WebPrivilegeCategories getPrivilegeCategories()
                                       throws WebBeanException

Returns a set of categorized privileges for the current user. Each category will contain all privileges defined for that category, regardless of whether the user has the privilege or not.

Returns:

A WebPrivilegeCategories collection

Throws:

WebBeanException - Thrown if any error occurs when retrieving the privileges