|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssGroup is a group of users.
Nested Class Summary |
Nested classes inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
Field Summary | |
static int |
PROP_COUNT_USERS
|
static int |
PROP_DESCRIPTION
|
static int |
PROP_EMAIL_ADDRESS
|
static int |
PROP_NAME
|
static int |
s_countProperties
|
static IEssValueAny.EEssDataType[] |
s_propDataTypes
|
static IEssProperties.EEssPropertyMode[] |
s_propModes
|
static java.lang.String[] |
s_propNames
|
Method Summary | |
void |
addUser(IEssUser user)
Adds a user to this group. |
IEssUser |
addUser(java.lang.String userName)
Adds a user to this group. |
void |
addUsers(IEssIterator users)
Adds a list of users to this group. |
IEssIterator |
addUsers(java.lang.String[] userNames)
Adds a list of users to this group. |
void |
delete()
Deletes this group. |
int |
getCountUsers()
Gets the count of users in this group. |
java.lang.String |
getDescription()
Gets the group description. |
java.lang.String |
getEmailAddress()
Gets the group email address. |
java.lang.String |
getName()
Gets the group name. |
IEssIterator |
getUsers()
Gets the list of users in this group. |
void |
refreshPropertyValues()
Refreshes the property values. |
void |
removeUser(IEssUser user)
Removes a user from this group. |
void |
removeUser(java.lang.String userName)
Removes a user from this group. |
void |
removeUsers(IEssIterator users)
Removes a list of users from this group. |
void |
removeUsers(java.lang.String[] userNames)
Removes a list of users from this group. |
void |
setDescription(java.lang.String desc)
Sets the group description. |
void |
setEmailAddress(java.lang.String emailAddress)
Sets the group email address. |
void |
updatePropertyValues()
Updates the property values. |
Methods inherited from interface com.essbase.api.base.IEssExtendedObject |
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled |
Methods inherited from interface com.essbase.api.base.IEssProperties |
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny |
Field Detail |
public static final int PROP_NAME
public static final int PROP_DESCRIPTION
public static final int PROP_EMAIL_ADDRESS
public static final int PROP_COUNT_USERS
public static final int s_countProperties
public static final java.lang.String[] s_propNames
public static final IEssValueAny.EEssDataType[] s_propDataTypes
public static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
public java.lang.String getName() throws EssException
getName
in interface IEssExtendedObject
EssException
- if an error occurs.public java.lang.String getDescription() throws EssException
EssException
- if an error occurs.public void setDescription(java.lang.String desc) throws EssException
desc
- The group description.
EssException
- if an error occurs.public java.lang.String getEmailAddress() throws EssException
EssException
- if an error occurs.public void setEmailAddress(java.lang.String emailAddress) throws EssException
emailAddress
- The group email address.
EssException
- if an error occurs.public int getCountUsers() throws EssException
EssException
- if an error occurs.public void refreshPropertyValues() throws EssException
refreshPropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void updatePropertyValues() throws EssException
updatePropertyValues
in interface IEssProperties
EssException
- if an error occurs.public IEssUser addUser(java.lang.String userName) throws EssException
userName
- The user name.
EssException
- if an error occurs.public void addUser(IEssUser user) throws EssException
user
- The user.
EssException
- if an error occurs.public void removeUser(java.lang.String userName) throws EssException
userName
- The user name.
EssException
- if an error occurs.public void removeUser(IEssUser user) throws EssException
user
- The user.
EssException
- if an error occurs.public IEssIterator addUsers(java.lang.String[] userNames) throws EssException
userNames
- The user names.
EssException
- if an error occurs.public void addUsers(IEssIterator users) throws EssException
users
- The users.
EssException
- if an error occurs.public void removeUsers(java.lang.String[] userNames) throws EssException
userNames
- The user names.
EssException
- if an error occurs.public void removeUsers(IEssIterator users) throws EssException
users
- The users.
EssException
- if an error occurs.public IEssIterator getUsers() throws EssException
EssException
- if an error occurs.public void delete() throws EssException
EssException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |