|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssUser is the user.
Nested Class Summary |
Nested classes inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
Field Summary | |
static int |
PROP_AUTHENTICATOR
|
static int |
PROP_COUNT_GROUPS
|
static int |
PROP_DESCRIPTION
|
static int |
PROP_EMAIL_ADDRESS
|
static int |
PROP_FIRST_NAME
|
static int |
PROP_GROUP_NAMES
|
static int |
PROP_IDENTITY
|
static int |
PROP_IS_ROLE_ADMINISTRATOR
|
static int |
PROP_LAST_NAME
|
static int |
PROP_NAME
|
static int |
PROP_PASSWORD
|
static int |
s_countProperties
|
static IEssValueAny.EEssDataType[] |
s_propDataTypes
|
static IEssProperties.EEssPropertyMode[] |
s_propModes
|
static java.lang.String[] |
s_propNames
|
Method Summary | |
void |
delete()
Deletes this user from the domain. |
IEssbase.EEssAuthenticatorType |
getAuthenticatorType()
Gets the type of the authenticator. |
int |
getCountGroups()
Gets the count of groups this users belongs to. |
java.io.Serializable |
getCustomProperty(java.lang.String propName)
Gets a custom property. |
java.lang.String |
getDescription()
Gets the user description. |
java.lang.String |
getEmailAddress()
Gets the user email address. |
java.lang.String |
getFirstName()
Gets the first name of the user. |
java.lang.String[] |
getGroupNames()
Gets the names of groups this users belongs to. |
IEssIterator |
getGroups()
Gets the list of groups this users belongs to. |
java.lang.String |
getIdentity()
Gets the identity for external CSS users. |
java.lang.String |
getLastName()
Gets the last name of the user. |
java.lang.String |
getName()
Gets the user name. |
boolean |
isRoleAdministrator()
Checks if user plays the role of administrator. |
void |
refreshPropertyValues()
Refreshes the property values. |
void |
setAuthenticatorType(IEssbase.EEssAuthenticatorType authenticator)
Sets the type of the authenticator. |
void |
setCustomProperty(java.lang.String propName,
java.io.Serializable value)
Sets a custom property. |
void |
setDescription(java.lang.String desc)
Sets the user description. |
void |
setEmailAddress(java.lang.String emailAddress)
Sets the user email address. |
void |
setFirstName(java.lang.String firstName)
Sets the first name of the user. |
void |
setIdentity(java.lang.String identity)
Sets the identity for external CSS users. |
void |
setLastName(java.lang.String lastName)
Sets the last name of the user. |
void |
setPassword(java.lang.String password)
Sets the user password. |
void |
setRoleAdministrator(boolean isRoleAdmin)
Sets if user plays the role of administrator. |
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 |
public static final int PROP_NAME
public static final int PROP_DESCRIPTION
public static final int PROP_AUTHENTICATOR
public static final int PROP_PASSWORD
public static final int PROP_EMAIL_ADDRESS
public static final int PROP_COUNT_GROUPS
public static final int PROP_GROUP_NAMES
public static final int PROP_IS_ROLE_ADMINISTRATOR
public static final int PROP_FIRST_NAME
public static final int PROP_LAST_NAME
public static final int PROP_IDENTITY
public static final int s_countProperties
public static final java.lang.String[] s_propNames
public static final IEssValueAny.EEssDataType[] s_propDataTypes
public static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
public java.lang.String getName() throws EssException
getName
in interface IEssExtendedObject
EssException
- if an error occurs.public java.lang.String getFirstName() throws EssException
EssException
- if an error occurs.public void setFirstName(java.lang.String firstName) throws EssException
firstName
- The first name.
EssException
- if an error occurs.public java.lang.String getLastName() throws EssException
EssException
- if an error occurs.public void setLastName(java.lang.String lastName) throws EssException
lastName
- The last name.
EssException
- if an error occurs.public java.lang.String getDescription() throws EssException
EssException
- if an error occurs.public void setDescription(java.lang.String desc) throws EssException
desc
- The user description.
EssException
- if an error occurs.public void setPassword(java.lang.String password) throws EssException
password
- The user password. Password must be at least 6 characters.
EssException
- if an error occurs.public java.lang.String getEmailAddress() throws EssException
EssException
- if an error occurs.public void setEmailAddress(java.lang.String emailAddress) throws EssException
emailAddress
- The user email address.
EssException
- if an error occurs.public java.lang.String getIdentity() throws EssException
EssException
- if an error occurs.public void setIdentity(java.lang.String identity) throws EssException
identity
- The identify for external CSS users.
EssException
- if an error occurs.public java.io.Serializable getCustomProperty(java.lang.String propName) throws EssException
propName
- The custom property name.
EssException
- if an error occurs.public void setCustomProperty(java.lang.String propName, java.io.Serializable value) throws EssException
propName
- The custom property name.value
- The property value.
EssException
- if an error occurs.public int getCountGroups() throws EssException
EssException
- if an error occurs.public java.lang.String[] getGroupNames() throws EssException
EssException
- if an error occurs.public boolean isRoleAdministrator() throws EssException
EssException
- if an error occurs.public void setRoleAdministrator(boolean isRoleAdmin) throws EssException
isRoleAdmin
- true if user is administrator.
EssException
- if an error occurs.public IEssbase.EEssAuthenticatorType getAuthenticatorType() throws EssException
EssException
- if an error occurs.public void setAuthenticatorType(IEssbase.EEssAuthenticatorType authenticator) throws EssException
authenticator
- The authenticator type.
EssException
- if an error occurs.public void refreshPropertyValues() throws EssException
refreshPropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void updatePropertyValues() throws EssException
updatePropertyValues
in interface IEssProperties
EssException
- if an error occurs.public IEssIterator getGroups() throws EssException
EssException
- if an error occurs.public void delete() throws EssException
EssException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |