Package com.appliedolap.essbase

Interface EssUser

All Superinterfaces:

EssObject

All Known Implementing Classes:

EssUserImpl

public interface EssUser
extends EssObject

Nested Class Summary

Nested classes/interfaces inherited from interface com.appliedolap.essbase.EssObject

EssObject.Type

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()
String	getEmail()
String	getName()	Returns the user ID.
EssServer	getServer()	Get the owning server of this user.
EssObject.Type	getType()	Gets the type of this object.

Method Details

getName

String getName()

Returns the user ID. This might seem a little weird given that the user object has a 'name' property on it, but the getName method is meant to always return at least something, and the name field on an Essbase user can be blank, but the ID cannot. So in this case, the value returned here is mapped to the user ID. Use getDisplayName() to get the name field from the Essbase user object.

Specified by:

getName in interface EssObject

Returns:

the user ID

getType

EssObject.Type getType()

Description copied from interface: EssObject

Gets the type of this object.

Specified by:

getType in interface EssObject

Returns:

the object type

getDisplayName

String getDisplayName()

getEmail

String getEmail()

getServer

EssServer getServer()

Get the owning server of this user.

Returns:

the server associated with this user