com.essbase.api.datasource

Interface IEssOlapGroup

All Superinterfaces:

IEssBaseObject, IEssExtendedObject, IEssProperties

public interface IEssOlapGroup
extends IEssExtendedObject, IEssProperties

Nested Class Summary

Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties

IEssProperties.EEssPropertyMode

Field Summary

Fields

Modifier and Type	Field and Description
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

Modifier and Type	Method and Description
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

PROP_NAME

static final int PROP_NAME

See Also:

Constant Field Values

PROP_ACCESS

static final int PROP_ACCESS

See Also:

Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_EMAIL_ID

static final int PROP_EMAIL_ID

See Also:

Constant Field Values

s_countProperties

static final int s_countProperties

See Also:

Constant Field Values

s_propNames

static final java.lang.String[] s_propNames

s_propDataTypes

static final IEssValueAny.EEssDataType[] s_propDataTypes

s_propModes

static final IEssProperties.EEssPropertyMode[] s_propModes

Method Detail

getName

java.lang.String getName()
                  throws com.essbase.api.base.EssException

Gets the Internally/ Externally authenticed User name.

Specified by:

getName in interface IEssExtendedObject

Returns:

The user name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getAccess

long getAccess()
        throws com.essbase.api.base.EssException

Gets the default access privileges assigned to user.

Returns:

long Access

Throws:

com.essbase.api.base.EssException - if an error occurs.

setAccess

void setAccess(long access)
        throws com.essbase.api.base.EssException

Sets the default access privileges assigned to user.

Parameters:

access - - access level to be set

Throws:

com.essbase.api.base.EssException - if an error occurs.

getDescription

java.lang.String getDescription()
                         throws com.essbase.api.base.EssException

Get user description.

Returns:

String Description

Throws:

com.essbase.api.base.EssException - if an error occurs.

getEmailID

java.lang.String getEmailID()
                     throws com.essbase.api.base.EssException

Get user email ID.

Returns:

String EmailID

Throws:

com.essbase.api.base.EssException - if an error occurs.

getUsers

IEssIterator getUsers()
               throws com.essbase.api.base.EssException

Gets the list of users that belong to this group.

Returns:

String ConnectionParam

Throws:

com.essbase.api.base.EssException - if an error occurs.

refreshPropertyValues

void refreshPropertyValues()
                    throws com.essbase.api.base.EssException

Refreshes the property values. The JAPI cache for this object is refreshed with the latest values from the server, so that all the getXXX() methods will return the latest values.

Specified by:

refreshPropertyValues in interface IEssProperties

Throws:

com.essbase.api.base.EssException - if an error occurs.

updatePropertyValues

void updatePropertyValues()
                   throws com.essbase.api.base.EssException

Updates the property values. The changes made to this object via setXXX() methods will become effective only after you invoke updatePropertyValues().

Specified by:

updatePropertyValues in interface IEssProperties

Throws:

com.essbase.api.base.EssException - if an error occurs.

syncGroupWithApp

void syncGroupWithApp(IEssOlapApplication application)
               throws com.essbase.api.base.EssException

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. If Essbase has not been migrated to Shared Services, this function is not supported and returns an error. This function requires the caller to be an Administrator.

Parameters:

application - - IEssOlapApplication, the application to sync with

Throws:

com.essbase.api.base.EssException - if an error occurs.

delete

void delete()
     throws com.essbase.api.base.EssException

Deletes the group. This method requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Throws:

com.essbase.api.base.EssException - if an error occurs.

addUser

void addUser(IEssOlapUser user)
      throws com.essbase.api.base.EssException

Adds specified user to the list of group members. It also adds the group to the user's own list of groups. This method requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Parameters:

user - user to be added in the group.

Throws:

com.essbase.api.base.EssException - if an error occurs.

removeUser

void removeUser(IEssOlapUser user)
         throws com.essbase.api.base.EssException

removes specified user from the list of group members. Also the group will be removed from user's own list. This method requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Parameters:

user - User to be removed from the group.

Throws:

com.essbase.api.base.EssException - if an error occurs.