Package com.microstrategy.web.beans

Interface UserEntitiesBean

All Superinterfaces:

EnumWebPersistableState, Persistable, RequestPersistable, Scrollable, Transformable, WebBean, WebComponent

public interface UserEntitiesBean
extends WebBean, Scrollable

This interface represents a collection of users. It can be obtained from UserEntityBean.getParentGroups() or UserGroupBean.getChildren().

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

Method Summary

Modifier and Type	Method	Description
void	add(UserEntityBean param)	Adds a new user into this collection.
void	clear()	Clear the whole collection.
java.util.Enumeration	elements()	Returns an Enumeration of this collection.
UserEntityBean	get(int index)	Returns the user in this collection by its index.
int	getSourceType()	Returns the source type from EnumUserEntitiesSourceTypes to indicate where the current user entities collection comes from.
void	remove(UserEntityBean param)	Removes an existing user.
void	setSourceType(int sourceType)	Sets the source type from EnumUserEntitiesSourceTypes to indicate where the current user entities collection comes from.
int	size()	Returns the number of user in this collection.
int	totalCount()

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

add

void add(UserEntityBean param)
  throws WebBeanException

Adds a new user into this collection.

Parameters:

param - UserEntityBean The new user to add.

Throws:

WebBeanException - Thrown when error occurs.

remove

void remove(UserEntityBean param)
     throws WebBeanException

Removes an existing user.

Parameters:

param - UserEntityBean The user to remove.

Throws:

WebBeanException - Thrown when error occurs.

elements

java.util.Enumeration elements()
                        throws WebBeanException

Returns an Enumeration of this collection.

Returns:

Enumeration

Throws:

WebBeanException

size

int size()
  throws WebBeanException

Returns the number of user in this collection.

Returns:

int the size of this collection.

Throws:

WebBeanException - Thrown when error ocurrs.

totalCount

int totalCount()

get

UserEntityBean get(int index)
            throws WebBeanException

Returns the user in this collection by its index.

Parameters:

index - int The index of the user to reach.

Returns:

UserEntityBean The user in the bean at the specified index.

Throws:

WebBeanException - Thrown when error occurs.

setSourceType

void setSourceType(int sourceType)

Sets the source type from EnumUserEntitiesSourceTypes to indicate where the current user entities collection comes from.

Parameters:

sourceType - the source type.

Since:

MicroStrategy Web 9.0.0

getSourceType

int getSourceType()

Returns the source type from EnumUserEntitiesSourceTypes to indicate where the current user entities collection comes from.

Returns:

the source type.

Since:

MicroStrategy Web 9.0.0

clear

void clear()
    throws WebBeanException

Clear the whole collection.

Throws:

WebBeanException - Thrown when error occurs.

Since:

MicroStrategy Web 9.0.0