|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Deprecated. This interface has been deprecated. User/groups in the APS server are no longer supported.
public interface IEssGroup
The IEssGroup is a group of users.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties |
---|
IEssProperties.EEssPropertyMode |
Field Summary | |
---|---|
static int |
PROP_COUNT_USERS Deprecated. |
static int |
PROP_DESCRIPTION Deprecated. |
static int |
PROP_EMAIL_ADDRESS Deprecated. |
static int |
PROP_NAME Deprecated. |
static int |
s_countProperties Deprecated. |
static IEssValueAny.EEssDataType[] |
s_propDataTypes Deprecated. |
static IEssProperties.EEssPropertyMode[] |
s_propModes Deprecated. |
static java.lang.String[] |
s_propNames Deprecated. |
Method Summary | |
---|---|
void |
addUser(IEssUser user) Deprecated. Adds a user to this group. |
IEssUser |
addUser(java.lang.String userName) Deprecated. Adds a user to this group. |
void |
addUsers(IEssIterator users) Deprecated. Adds a list of users to this group. |
IEssIterator |
addUsers(java.lang.String[] userNames) Deprecated. Adds a list of users to this group. |
void |
delete() Deprecated. Deletes this group. |
int |
getCountUsers() Deprecated. Gets the count of users in this group. |
java.lang.String |
getDescription() Deprecated. Gets the group description. |
java.lang.String |
getEmailAddress() Deprecated. Gets the group email address. |
java.lang.String |
getName() Deprecated. Gets the group name. |
IEssIterator |
getUsers() Deprecated. Gets the list of users in this group. |
void |
refreshPropertyValues() Deprecated. Refreshes the property values. |
void |
removeUser(IEssUser user) Deprecated. Removes a user from this group. |
void |
removeUser(java.lang.String userName) Deprecated. Removes a user from this group. |
void |
removeUsers(IEssIterator users) Deprecated. Removes a list of users from this group. |
void |
removeUsers(java.lang.String[] userNames) Deprecated. Removes a list of users from this group. |
void |
setDescription(java.lang.String desc) Deprecated. Sets the group description. |
void |
setEmailAddress(java.lang.String emailAddress) Deprecated. Sets the group email address. |
void |
updatePropertyValues() Deprecated. 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 |
---|
static final int PROP_NAME
static final int PROP_DESCRIPTION
static final int PROP_EMAIL_ADDRESS
static final int PROP_COUNT_USERS
static final int s_countProperties
static final java.lang.String[] s_propNames
static final IEssValueAny.EEssDataType[] s_propDataTypes
static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
---|
java.lang.String getName() throws com.essbase.api.base.EssException
getName
in interface IEssExtendedObject
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDescription() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDescription(java.lang.String desc) throws com.essbase.api.base.EssException
desc
- The group description.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getEmailAddress() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setEmailAddress(java.lang.String emailAddress) throws com.essbase.api.base.EssException
emailAddress
- The group email address.com.essbase.api.base.EssException
- if an error occurs.int getCountUsers() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void refreshPropertyValues() throws com.essbase.api.base.EssException
refreshPropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.void updatePropertyValues() throws com.essbase.api.base.EssException
updatePropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.IEssUser addUser(java.lang.String userName) throws com.essbase.api.base.EssException
userName
- The user name.com.essbase.api.base.EssException
- if an error occurs.void addUser(IEssUser user) throws com.essbase.api.base.EssException
user
- The user.com.essbase.api.base.EssException
- if an error occurs.void removeUser(java.lang.String userName) throws com.essbase.api.base.EssException
userName
- The user name.com.essbase.api.base.EssException
- if an error occurs.void removeUser(IEssUser user) throws com.essbase.api.base.EssException
user
- The user.com.essbase.api.base.EssException
- if an error occurs.IEssIterator addUsers(java.lang.String[] userNames) throws com.essbase.api.base.EssException
userNames
- The user names.com.essbase.api.base.EssException
- if an error occurs.void addUsers(IEssIterator users) throws com.essbase.api.base.EssException
users
- The users.com.essbase.api.base.EssException
- if an error occurs.void removeUsers(java.lang.String[] userNames) throws com.essbase.api.base.EssException
userNames
- The user names.com.essbase.api.base.EssException
- if an error occurs.void removeUsers(IEssIterator users) throws com.essbase.api.base.EssException
users
- The users.com.essbase.api.base.EssException
- if an error occurs.IEssIterator getUsers() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void delete() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |