| com.microstrategy.web.beans.UserEntitiesBean |
Class Overview
This interface represents a collection of users. It can be obtained from getParentGroups()
or getChildren().
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
com.microstrategy.utils.serialization.EnumWebPersistableState
| |||||||||||
|
From interface
com.microstrategy.web.objects.Scrollable
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
add(UserEntityBean param)
Adds a new user into this collection.
| ||||||||||
| abstract void |
clear()
Clear the whole collection.
| ||||||||||
| abstract Enumeration |
elements()
Returns an Enumeration of this collection.
| ||||||||||
| abstract UserEntityBean |
get(int index)
Returns the user in this collection by its index.
| ||||||||||
| abstract int |
getSourceType()
Returns the source type from
EnumUserEntitiesSourceTypes to indicate where
the current user entities collection comes from. | ||||||||||
| abstract void |
remove(UserEntityBean param)
Removes an existing user.
| ||||||||||
| abstract void |
setSourceType(int sourceType)
Sets the source type from
EnumUserEntitiesSourceTypes to indicate where
the current user entities collection comes from. | ||||||||||
| abstract int |
size()
Returns the number of user in this collection.
| ||||||||||
| abstract int | totalCount() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.serialization.Persistable
| |||||||||||
|
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
| |||||||||||
|
From interface
com.microstrategy.web.objects.Scrollable
| |||||||||||
Public Methods
public abstract void add (UserEntityBean param)
Adds a new user into this collection.
Parameters
| param | UserEntityBean The new user to add. |
|---|
Throws
| WebBeanException | Thrown when error occurs. |
|---|
public abstract void clear ()
Clear the whole collection.
Throws
| WebBeanException | Thrown when error occurs. |
|---|
public abstract Enumeration elements ()
Returns an Enumeration of this collection.
Returns
- Enumeration
Throws
| WebBeanException | |
| WebBeanException |
public abstract UserEntityBean get (int index)
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. |
|---|
public abstract int getSourceType ()
Returns the source type from EnumUserEntitiesSourceTypes to indicate where
the current user entities collection comes from.
Returns
- the source type.
public abstract void remove (UserEntityBean param)
Removes an existing user.
Parameters
| param | UserEntityBean The user to remove. |
|---|
Throws
| WebBeanException | Thrown when error occurs. |
|---|
public abstract 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. |
|---|
public abstract int size ()
Returns the number of user in this collection.
Returns
- int the size of this collection.
Throws
| WebBeanException | Thrown when error ocurrs. |
|---|