com.essbase.api.domain

Interface IEssUser

All Superinterfaces:

IEssBaseObject, IEssExtendedObject, IEssProperties

Deprecated.

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

public interface IEssUser
extends IEssExtendedObject, IEssProperties

The IEssUser is the user.

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

Fields

Modifier and Type	Field and Description
static int	PROP_AUTHENTICATOR Deprecated.
static int	PROP_COUNT_GROUPS Deprecated.
static int	PROP_DESCRIPTION Deprecated.
static int	PROP_EMAIL_ADDRESS Deprecated.
static int	PROP_FIRST_NAME Deprecated.
static int	PROP_GROUP_NAMES Deprecated.
static int	PROP_IDENTITY Deprecated.
static int	PROP_IS_ROLE_ADMINISTRATOR Deprecated.
static int	PROP_LAST_NAME Deprecated.
static int	PROP_NAME Deprecated.
static int	PROP_PASSWORD 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

Modifier and Type	Method and Description
void	delete() Deprecated. Deletes this user from the domain.
IEssbase.EEssAuthenticatorType	getAuthenticatorType() Deprecated. Gets the type of the authenticator.
int	getCountGroups() Deprecated. Gets the count of groups this users belongs to.
java.io.Serializable	getCustomProperty(java.lang.String propName) Deprecated. Gets a custom property.
java.lang.String	getDescription() Deprecated. Gets the user description.
java.lang.String	getEmailAddress() Deprecated. Gets the user email address.
java.lang.String	getFirstName() Deprecated. Gets the first name of the user.
java.lang.String[]	getGroupNames() Deprecated. Gets the names of groups this users belongs to.
IEssIterator	getGroups() Deprecated. Gets the list of groups this users belongs to.
java.lang.String	getIdentity() Deprecated. Gets the identity for external CSS users.
java.lang.String	getLastName() Deprecated. Gets the last name of the user.
java.lang.String	getName() Deprecated. Gets the user name.
boolean	isRoleAdministrator() Deprecated. Checks if user plays the role of administrator.
void	refreshPropertyValues() Deprecated. Refreshes the property values.
void	setAuthenticatorType(IEssbase.EEssAuthenticatorType authenticator) Deprecated. Sets the type of the authenticator.
void	setCustomProperty(java.lang.String propName, java.io.Serializable value) Deprecated. Sets a custom property.
void	setDescription(java.lang.String desc) Deprecated. Sets the user description.
void	setEmailAddress(java.lang.String emailAddress) Deprecated. Sets the user email address.
void	setFirstName(java.lang.String firstName) Deprecated. Sets the first name of the user.
void	setIdentity(java.lang.String identity) Deprecated. Sets the identity for external CSS users.
void	setLastName(java.lang.String lastName) Deprecated. Sets the last name of the user.
void	setPassword(java.lang.String password) Deprecated. Sets the user password.
void	setRoleAdministrator(boolean isRoleAdmin) Deprecated. Sets if user plays the role of administrator.
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_AUTHENTICATOR

static final int PROP_AUTHENTICATOR

Deprecated.

See Also:

Constant Field Values

PROP_PASSWORD

static final int PROP_PASSWORD

Deprecated.

See Also:

Constant Field Values

PROP_EMAIL_ADDRESS

static final int PROP_EMAIL_ADDRESS

Deprecated.

See Also:

Constant Field Values

PROP_COUNT_GROUPS

static final int PROP_COUNT_GROUPS

Deprecated.

See Also:

Constant Field Values

PROP_GROUP_NAMES

static final int PROP_GROUP_NAMES

Deprecated.

See Also:

Constant Field Values

PROP_IS_ROLE_ADMINISTRATOR

static final int PROP_IS_ROLE_ADMINISTRATOR

Deprecated.

See Also:

Constant Field Values

PROP_FIRST_NAME

static final int PROP_FIRST_NAME

Deprecated.

See Also:

Constant Field Values

PROP_LAST_NAME

static final int PROP_LAST_NAME

Deprecated.

See Also:

Constant Field Values

PROP_IDENTITY

static final int PROP_IDENTITY

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 user name.

Specified by:

getName in interface IEssExtendedObject

Returns:

The user name.

Throws:

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

getFirstName

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

Deprecated.

Gets the first name of the user.

Returns:

The first name.

Throws:

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

setFirstName

void setFirstName(java.lang.String firstName)
           throws com.essbase.api.base.EssException

Deprecated.

Sets the first name of the user.

Parameters:

firstName - The first name.

Throws:

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

getLastName

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

Deprecated.

Gets the last name of the user.

Returns:

The last name.

Throws:

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

setLastName

void setLastName(java.lang.String lastName)
          throws com.essbase.api.base.EssException

Deprecated.

Sets the last name of the user.

Parameters:

lastName - The last 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 user description.

Returns:

The user 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 user description. Only the administrator is allowed to perform this operation. The change will become effective after you invoke updatePropertyValues().

Parameters:

desc - The user description.

Throws:

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

setPassword

void setPassword(java.lang.String password)
          throws com.essbase.api.base.EssException

Deprecated.

Sets the user password. Both the administrator and the user himself are allowed to perform this operation. The change will become effective after you invoke updatePropertyValues().

Parameters:

password - The user password. Password must be at least 6 characters.

Throws:

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

getEmailAddress

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

Deprecated.

Gets the user email address.

Returns:

The user 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 user email address. Only the administrator is allowed to perform this operation. The change will become effective after you invoke updatePropertyValues().

Parameters:

emailAddress - The user email address.

Throws:

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

getIdentity

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

Deprecated.

Gets the identity for external CSS users.

Returns:

The identify for external CSS users.

Throws:

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

setIdentity

void setIdentity(java.lang.String identity)
          throws com.essbase.api.base.EssException

Deprecated.

Sets the identity for external CSS users.

Parameters:

identity - The identify for external CSS users.

Throws:

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

getCustomProperty

java.io.Serializable getCustomProperty(java.lang.String propName)
                                throws com.essbase.api.base.EssException

Deprecated.

Gets a custom property.

Parameters:

propName - The custom property name.

Returns:

The property value.

Throws:

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

setCustomProperty

void setCustomProperty(java.lang.String propName,
                       java.io.Serializable value)
                throws com.essbase.api.base.EssException

Deprecated.

Sets a custom property. Both the administrator and the user himself are allowed to perform this operation. The change will become effective after you invoke updatePropertyValues().

Parameters:

propName - The custom property name.

value - The property value.

Throws:

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

getCountGroups

int getCountGroups()
            throws com.essbase.api.base.EssException

Deprecated.

Gets the count of groups this users belongs to.

Returns:

The count of group this user belongs to.

Throws:

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

getGroupNames

java.lang.String[] getGroupNames()
                          throws com.essbase.api.base.EssException

Deprecated.

Gets the names of groups this users belongs to.

Returns:

The names of group this user belongs to.

Throws:

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

isRoleAdministrator

boolean isRoleAdministrator()
                     throws com.essbase.api.base.EssException

Deprecated.

Checks if user plays the role of administrator.

Returns:

true if user is administrator.

Throws:

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

setRoleAdministrator

void setRoleAdministrator(boolean isRoleAdmin)
                   throws com.essbase.api.base.EssException

Deprecated.

Sets if user plays the role of administrator. Only the administrator is allowed to perform this operation.

Parameters:

isRoleAdmin - true if user is administrator.

Throws:

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

getAuthenticatorType

IEssbase.EEssAuthenticatorType getAuthenticatorType()
                                             throws com.essbase.api.base.EssException

Deprecated.

Gets the type of the authenticator.

Returns:

The authenticator type.

Throws:

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

setAuthenticatorType

void setAuthenticatorType(IEssbase.EEssAuthenticatorType authenticator)
                   throws com.essbase.api.base.EssException

Deprecated.

Sets the type of the authenticator. Only the administrator is allowed to perform this operation.

Parameters:

authenticator - The authenticator type.

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.

getGroups

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

Deprecated.

Gets the list of groups this users belongs to.

Returns:

The list of group this user belongs to.

Throws:

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

delete

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

Deprecated.

Deletes this user from the domain.

Throws:

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