Skip navigation links


com.essbase.api.domain
Interface IEssGroup

All Superinterfaces:
IEssBaseObject, IEssExtendedObject, IEssProperties

Deprecated. This interface has been deprecated. User/groups in the APS server are no longer supported.

public interface IEssGroup
extends IEssExtendedObject, IEssProperties

The IEssGroup is a group of users.

Version:
1.0, 04/04/2001
Author:
Srini Ranga

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

PROP_NAME

static final int PROP_NAME
Deprecated. 
See Also:
Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION
Deprecated. 
See Also:
Constant Field Values

PROP_EMAIL_ADDRESS

static final int PROP_EMAIL_ADDRESS
Deprecated. 
See Also:
Constant Field Values

PROP_COUNT_USERS

static final int PROP_COUNT_USERS
Deprecated. 
See Also:
Constant Field Values

s_countProperties

static final int s_countProperties
Deprecated. 
See Also:
Constant Field Values

s_propNames

static final java.lang.String[] s_propNames
Deprecated. 

s_propDataTypes

static final IEssValueAny.EEssDataType[] s_propDataTypes
Deprecated. 

s_propModes

static final IEssProperties.EEssPropertyMode[] s_propModes
Deprecated. 

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.EssException
Deprecated. 
Gets the group name.
Specified by:
getName in interface IEssExtendedObject
Returns:
The group name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDescription

java.lang.String getDescription()
                                throws com.essbase.api.base.EssException
Deprecated. 
Gets the group description.
Returns:
The group description.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setDescription

void setDescription(java.lang.String desc)
                    throws com.essbase.api.base.EssException
Deprecated. 
Sets the group description. The change will become effective after you invoke updatePropertyValues().
Parameters:
desc - The group description.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getEmailAddress

java.lang.String getEmailAddress()
                                 throws com.essbase.api.base.EssException
Deprecated. 
Gets the group email address.
Returns:
The group email address.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setEmailAddress

void setEmailAddress(java.lang.String emailAddress)
                     throws com.essbase.api.base.EssException
Deprecated. 
Sets the group email address. The change will become effective after you invoke updatePropertyValues().
Parameters:
emailAddress - The group email address.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountUsers

int getCountUsers()
                  throws com.essbase.api.base.EssException
Deprecated. 
Gets the count of users in this group.
Returns:
The count of users.
Throws:
com.essbase.api.base.EssException - if an error occurs.

refreshPropertyValues

void refreshPropertyValues()
                           throws com.essbase.api.base.EssException
Deprecated. 
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
Deprecated. 
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.

addUser

IEssUser addUser(java.lang.String userName)
                 throws com.essbase.api.base.EssException
Deprecated. 
Adds a user to this group.
Parameters:
userName - The user name.
Returns:
The user.
Throws:
com.essbase.api.base.EssException - if an error occurs.

addUser

void addUser(IEssUser user)
             throws com.essbase.api.base.EssException
Deprecated. 
Adds a user to this group.
Parameters:
user - The user.
Throws:
com.essbase.api.base.EssException - if an error occurs.

removeUser

void removeUser(java.lang.String userName)
                throws com.essbase.api.base.EssException
Deprecated. 
Removes a user from this group.
Parameters:
userName - The user name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

removeUser

void removeUser(IEssUser user)
                throws com.essbase.api.base.EssException
Deprecated. 
Removes a user from this group.
Parameters:
user - The user.
Throws:
com.essbase.api.base.EssException - if an error occurs.

addUsers

IEssIterator addUsers(java.lang.String[] userNames)
                      throws com.essbase.api.base.EssException
Deprecated. 
Adds a list of users to this group.
Parameters:
userNames - The user names.
Returns:
The list of users added (each of type IEssUser).
Throws:
com.essbase.api.base.EssException - if an error occurs.

addUsers

void addUsers(IEssIterator users)
              throws com.essbase.api.base.EssException
Deprecated. 
Adds a list of users to this group.
Parameters:
users - The users.
Throws:
com.essbase.api.base.EssException - if an error occurs.

removeUsers

void removeUsers(java.lang.String[] userNames)
                 throws com.essbase.api.base.EssException
Deprecated. 
Removes a list of users from this group.
Parameters:
userNames - The user names.
Throws:
com.essbase.api.base.EssException - if an error occurs.

removeUsers

void removeUsers(IEssIterator users)
                 throws com.essbase.api.base.EssException
Deprecated. 
Removes a list of users from this group.
Parameters:
users - The users.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getUsers

IEssIterator getUsers()
                      throws com.essbase.api.base.EssException
Deprecated. 
Gets the list of users in this group.
Returns:
The users (each of type IEssUser).
Throws:
com.essbase.api.base.EssException - if an error occurs.

delete

void delete()
            throws com.essbase.api.base.EssException
Deprecated. 
Deletes this group.
Throws:
com.essbase.api.base.EssException - if an error occurs.

Skip navigation links