public interface

UserEntityBean

implements EditableObjectBean
com.microstrategy.web.beans.UserEntityBean
Known Indirect Subclasses

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

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