|
|||||||||
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 IEssUser
The IEssUser is the user.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties |
---|
IEssProperties.EEssPropertyMode |
Field Summary | |
---|---|
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 | |
---|---|
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 |
---|
static final int PROP_NAME
static final int PROP_DESCRIPTION
static final int PROP_AUTHENTICATOR
static final int PROP_PASSWORD
static final int PROP_EMAIL_ADDRESS
static final int PROP_COUNT_GROUPS
static final int PROP_GROUP_NAMES
static final int PROP_IS_ROLE_ADMINISTRATOR
static final int PROP_FIRST_NAME
static final int PROP_LAST_NAME
static final int PROP_IDENTITY
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 getFirstName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setFirstName(java.lang.String firstName) throws com.essbase.api.base.EssException
firstName
- The first name.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getLastName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setLastName(java.lang.String lastName) throws com.essbase.api.base.EssException
lastName
- The last name.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 user description.com.essbase.api.base.EssException
- if an error occurs.void setPassword(java.lang.String password) throws com.essbase.api.base.EssException
password
- The user password. Password must be at least 6 characters.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 user email address.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getIdentity() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setIdentity(java.lang.String identity) throws com.essbase.api.base.EssException
identity
- The identify for external CSS users.com.essbase.api.base.EssException
- if an error occurs.java.io.Serializable getCustomProperty(java.lang.String propName) throws com.essbase.api.base.EssException
propName
- The custom property name.com.essbase.api.base.EssException
- if an error occurs.void setCustomProperty(java.lang.String propName, java.io.Serializable value) throws com.essbase.api.base.EssException
propName
- The custom property name.value
- The property value.com.essbase.api.base.EssException
- if an error occurs.int getCountGroups() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String[] getGroupNames() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean isRoleAdministrator() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setRoleAdministrator(boolean isRoleAdmin) throws com.essbase.api.base.EssException
isRoleAdmin
- true if user is administrator.com.essbase.api.base.EssException
- if an error occurs.IEssbase.EEssAuthenticatorType getAuthenticatorType() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setAuthenticatorType(IEssbase.EEssAuthenticatorType authenticator) throws com.essbase.api.base.EssException
authenticator
- The authenticator type.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.IEssIterator getGroups() 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 |