com.adobe.idp.taskmanager.dsc.client.query
Interface TMUser

All Superinterfaces:

java.io.Serializable

public interface TMUser
extends java.io.Serializable

Method Summary

java.lang.String	getBusinessCalendarKey() Retrieves the business Calendar Key.
java.lang.String	getCanonicalName() Retrieves the canonical name of this principal.
java.lang.String	getCommonName() Retrieves the common (display) name of this principal.
java.lang.String	getDescription() Retrieves the description.
java.util.Set	getDirectGroupMemberships() Retrieves a set of Group objects indicating those groups to which this principal directly belongs.
java.lang.String	getDisplayName()
java.lang.String	getDomainCommonName() Retrieves the common (display) name of the domain associated with this principal.
java.lang.String	getDomainName() Retrieves the canonical name of the domain associated with this principal.
java.lang.String	getEmail()
java.util.List	getEmailAlias() Retrieves a list of the secondary email addresses of the principal.
java.lang.String	getFamilyName() Retrieves the family name.
java.lang.String	getGivenName() Retrieves the given name.
java.util.Set	getGroupMemberships() Retrieves a set of Group objects indicating those groups to which this principal belongs.
java.lang.String	getId()
java.lang.String	getInitials() Retrieves the initials.
java.util.Locale	getLocale() Retrieves the locale.
java.lang.String	getLoginId()
java.lang.String	getOid() Retrieves the principal identifier.
java.lang.String	getOrg() Retrieves the organization to which the principal belongs.
java.lang.String	getPostalAddress() Retrieves the postal address.
java.lang.String	getPrincipalType() Retrieves the principal type.
java.util.Set	getRoleMembership() Retrieves a set of Role objects indicating those roles which this principal has.
java.lang.String	getStatus() Retrieves the principal's status.
java.lang.String	getTelephone()
java.lang.String	getTelephoneNumber() Retrieves the telephone number.
java.util.Date	getTimestampCreated() Retrieves the timestamp that was created for the principal.
java.util.Date	getTimestampUpdated() Retrieves the timestamp that was updated for the principal.
java.util.TimeZone	getTimezone() Retrieves the time zone.
java.lang.String	getUserid() Retrieves the user identifier.
int	getVisibility() Retrieves the visibility level of the principal, indicating whether the principal can be shown in the user interface, or whether it qualifies for searches.
boolean	isDisabled() Determines whether the user is disabled.
boolean	isLocal() Determines whether this principal is local.
boolean	isLocked() Determines whether this principal is locked.
boolean	isOutOfOffice()
boolean	isSystem() Determines whether this is a system principal.
void	setDescription(java.lang.String description) Sets the description.
void	setEmailAliases(java.util.List emailAlias) Sets the email aliases.

Method Detail

getId

java.lang.String getId()

getLoginId

java.lang.String getLoginId()

getDisplayName

java.lang.String getDisplayName()

getEmail

java.lang.String getEmail()

getTelephone

java.lang.String getTelephone()

isOutOfOffice

boolean isOutOfOffice()

getUserid

java.lang.String getUserid()

Retrieves the user identifier.

Returns:

The user identifier.

getFamilyName

java.lang.String getFamilyName()

Retrieves the family name.

Returns:

The family name.

getGivenName

java.lang.String getGivenName()

Retrieves the given name.

Returns:

The given name.

getInitials

java.lang.String getInitials()

Retrieves the initials.

Returns:

The initials.

getLocale

java.util.Locale getLocale()

Retrieves the locale.

Returns:

The locale.

getPostalAddress

java.lang.String getPostalAddress()

Retrieves the postal address.

Returns:

The postal address.

getTelephoneNumber

java.lang.String getTelephoneNumber()

Retrieves the telephone number.

Returns:

The telephone number.

getTimezone

java.util.TimeZone getTimezone()

Retrieves the time zone.

Returns:

The time zone.

getBusinessCalendarKey

java.lang.String getBusinessCalendarKey()

Retrieves the business Calendar Key.

Returns:

The business calendar key.

isDisabled

boolean isDisabled()

Determines whether the user is disabled.

Returns:

true if the user is disabled, false otherwise.

setEmailAliases

void setEmailAliases(java.util.List emailAlias)

Sets the email aliases.

Parameters:

emailAlias - A list of email aliases.

getDescription

java.lang.String getDescription()

Retrieves the description.

Returns:

The description.

getTimestampCreated

java.util.Date getTimestampCreated()

Retrieves the timestamp that was created for the principal.

Returns:

The timestamp that was created for the principal.

getTimestampUpdated

java.util.Date getTimestampUpdated()

Retrieves the timestamp that was updated for the principal.

Returns:

The timestamp that was updated for the principal.

setDescription

void setDescription(java.lang.String description)

Sets the description.

Parameters:

description - The description.

getCanonicalName

java.lang.String getCanonicalName()

Retrieves the canonical name of this principal. This string is unique within the scope of the domain. Thus the pair {getCanonicalName(), getDomainName()} uniquely identifies the principal.

Returns:

The canonical name of this principal.

getCommonName

java.lang.String getCommonName()

Retrieves the common (display) name of this principal.

Returns:

The common (display) name of this principal.

getDomainName

java.lang.String getDomainName()

Retrieves the canonical name of the domain associated with this principal.

Returns:

The canonical name of the domain associated with this principal.

getDomainCommonName

java.lang.String getDomainCommonName()

Retrieves the common (display) name of the domain associated with this principal.

Returns:

The common (display) name of the domain associated with this principal.

getOid

java.lang.String getOid()

Retrieves the principal identifier.

Returns:

The principal identifier.

getStatus

java.lang.String getStatus()

Retrieves the principal's status.

Returns:

The principal's status.

getEmailAlias

java.util.List getEmailAlias()

Retrieves a list of the secondary email addresses of the principal.

Returns:

A list of the secondary email addresses of the principal.

getGroupMemberships

java.util.Set getGroupMemberships()

Retrieves a set of Group objects indicating those groups to which this principal belongs.

Returns:

A set of groups to which this principal belongs. The returned value may be null, depending on the method that returned this object. For example, a search could omit this for efficiency.

getDirectGroupMemberships

java.util.Set getDirectGroupMemberships()

Retrieves a set of Group objects indicating those groups to which this principal directly belongs. This is a subset of those groups that would be returned by getGroupMemberships().

Returns:

A set of groups to which this principal directly belongs. The returned value may be null, depending on the method that returned this object. For example, a search could omit this for efficiency.

getRoleMembership

java.util.Set getRoleMembership()

Retrieves a set of Role objects indicating those roles which this principal has. The roles returned are either directly assigned or inherited by the principal from its ancestors.

Returns:

A set of groups to which this principal directly belongs. The returned value may be null, depending on the method that returned this object. For example, a search could omit this for efficiency.

getVisibility

int getVisibility()

Retrieves the visibility level of the principal, indicating whether the principal can be shown in the user interface, or whether it qualifies for searches.

Returns:

The visibility level of the principal. The default value is VISIBLITY_GUI.

getPrincipalType

java.lang.String getPrincipalType()

Retrieves the principal type.

Returns:

The principal type.

getOrg

java.lang.String getOrg()

Retrieves the organization to which the principal belongs.

Returns:

The organization to which the principal belongs.

isSystem

boolean isSystem()

Determines whether this is a system principal.

Returns:

true if this is a system principal, false otherwise.

isLocal

boolean isLocal()

Determines whether this principal is local.

Returns:

true if this principal is local, false otherwise.

isLocked

boolean isLocked()

Determines whether this principal is locked.

Returns:

true if the principal is locked, false otherwise.