|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssOlapGroup
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties |
---|
IEssProperties.EEssPropertyMode |
Field Summary | |
---|---|
static int |
PROP_ACCESS |
static int |
PROP_DESCRIPTION |
static int |
PROP_EMAIL_ID |
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(IEssOlapUser user) Adds specified user to the list of group members. |
void |
delete() Deletes the group. |
long |
getAccess() Gets the default access privileges assigned to user. |
java.lang.String |
getDescription() Get user description. |
java.lang.String |
getEmailID() Get user email ID. |
java.lang.String |
getName() Gets the Internally/ Externally authenticed User name. |
IEssIterator |
getUsers() Gets the list of users that belong to this group. |
void |
refreshPropertyValues() Refreshes the property values. |
void |
removeUser(IEssOlapUser user) removes specified user from the list of group members. |
void |
setAccess(long access) Sets the default access privileges assigned to user. |
void |
syncGroupWithApp(IEssOlapApplication application) Forces a group to be synchronized with security information for the application, so that the group's security information matches the status of Shared Services security. |
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 |
---|
static final int PROP_NAME
static final int PROP_ACCESS
static final int PROP_DESCRIPTION
static final int PROP_EMAIL_ID
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.long getAccess() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
void setAccess(long access) throws com.essbase.api.base.EssException
access
- - access level to be setcom.essbase.api.base.EssException
java.lang.String getDescription() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
java.lang.String getEmailID() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
IEssIterator getUsers() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
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.void syncGroupWithApp(IEssOlapApplication application) throws com.essbase.api.base.EssException
application
- - IEssOlapApplication, the application to sync withcom.essbase.api.base.EssException
void delete() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void addUser(IEssOlapUser user) throws com.essbase.api.base.EssException
user
- user to be added in the group.com.essbase.api.base.EssException
void removeUser(IEssOlapUser user) throws com.essbase.api.base.EssException
user
- User to be removed from the group.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 |