Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

UserEntityBean

implements EditableObjectBean

com.microstrategy.web.beans.UserEntityBean

Known Indirect Subclasses

UserBean, UserGroupBean

Class Overview

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

Summary

Constants
int	VIEWMODE_BROWSE	View mode of browsing.
int	VIEWMODE_EDIT	View mode of editing.

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

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

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.beans.EditableBean

From interface com.microstrategy.web.beans.EditableObjectBean

From interface com.microstrategy.web.beans.ObjectBean

abstract int	getBlockBegin() Returns the blockBegin property of the embedded `WebObjectSource`.
abstract int	getBlockCount() Returns the blockCount property of the embedded `WebObjectSource`.
abstract String	getDisplayName() Display name of the bean.
abstract int	getFlags() Returns the object flags from the embedded `WebObjectSource`.
abstract int	getLevel() Returns the level property of the embedded `WebObjectSource`.
abstract String	getObjectID() Returns the object's unique ID in the metadata.
abstract WebObjectInfo	getObjectInfo() Returns the the `WebObjectInfo` of the object.
abstract String	getObjectName() Returns the object's exact name in the metadata.
abstract int	getObjectType() Returns the type (`EnumDSSXMLObjectTypes`) of the object.
abstract FolderBean	getParentFolderBean(String name) Returns a `FolderBean` representing the parent folder of the current object.
abstract FolderBean	getParentFolderBean(String name, boolean populate) Returns a `FolderBean` representing the parent folder of the current object.
abstract String	getParentID() Returns the unique ID of the parent of the object.
abstract void	setBlockBegin(int blockBegin) Sets a new blockBegin property to the embedded `WebObjectSource`.
abstract void	setBlockCount(int blockCount) Sets the blockCount property of the embedded `WebObjectSource`.
abstract void	setFlags(int flags) Sets a new object flags on the embedded `WebObjectSource`.
abstract void	setLevel(int level) Sets the level property of the embedded `WebObjectSource`.
abstract void	setObjectID(String objectID) Sets the object's ID.
abstract void	setObjectInfo(WebObjectInfo oi) Sets the WebObjectInfo object that refers to the object.
abstract void	setObjectName(String objectName) Sets the object's name.
abstract void	setObjectType(int objectType) Sets the object' type (`EnumDSSXMLObjectTypes`).

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebBean

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Constants

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

Constant Value: 1 (0x00000001)

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

Constant Value: 2 (0x00000002)

Public Methods

public abstract UserEntitiesBean getParentGroups ()

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.

public abstract WebPrivilegeCategories getPrivilegeCategories ()

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

public abstract WebUserEntity getUserEntityObject ()

Returns the WebUserEntity object, this bean refers to.

Returns

WebUserEntity The user object this bean refers to.

Throws

WebBeanException	Thrown when error occurs.

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

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

public abstract void refresh ()

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

Throws

WebBeanException	Thrown when error happens during refresh.

public abstract void setViewMode (int mode)

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

Parameters

mode	int The new view mode.

Interfaces

Classes

Exceptions

UserEntityBean

Class Overview

Summary

Constants

public static final int VIEWMODE_BROWSE

public static final int VIEWMODE_EDIT

Public Methods

public abstract UserEntitiesBean getParentGroups ()

Returns

Throws

public abstract WebPrivilegeCategories getPrivilegeCategories ()

Returns

Throws

public abstract WebUserEntity getUserEntityObject ()

Returns

Throws

public abstract int getViewMode ()

Returns

public abstract boolean isGroup ()

Returns

public abstract void refresh ()

Throws

public abstract void setViewMode (int mode)

Parameters

See Also