com.adobe.idp.um.api.infomodel
Interface User

All Superinterfaces:

Principal

public interface User
extends Principal

The User class represents an extension of the Principal object. This class contains user-specific field accessor methods. Using an instance of this class, you can perform tasks such as programmatically adding LiveCycle ES2 users. To see an instance of this type used in a code example, see the Adding users using the Java API quick start in Programming with LiveCycle ES4.

See Also:

Principal

Field Summary

Fields inherited from interface com.adobe.idp.um.api.infomodel.Principal

PRINCIPALTYPE_GROUP, PRINCIPALTYPE_SERVICE, PRINCIPALTYPE_SPECIAL, PRINCIPALTYPE_SYSTEM, PRINCIPALTYPE_USER, STATUS_CURRENT, STATUS_OBSOLETE, VISIBILITY_SEARCHES, VISIBLITY_GUI, VISIBLITY_INVISIBLE

Method Summary

java.lang.String	getBusinessCalendarKey() Retrieves the business Calendar Key.
java.lang.String	getFamilyName() Retrieves the family name.
java.lang.String	getGivenName() Retrieves the given name.
java.lang.String	getInitials() Retrieves the initials.
java.util.Locale	getLocale() Retrieves the locale.
java.lang.String	getPostalAddress() Retrieves the postal address.
java.lang.String	getTelephoneNumber() Retrieves the telephone number.
java.util.TimeZone	getTimezone() Retrieves the time zone.
java.lang.String	getUserid() Retrieves the user identifier.
boolean	isDisabled() Determines whether the user is disabled.
void	setBusinessCalendarKey(java.lang.String bizCalKey) Sets the user's business calender key.
void	setDisabled(boolean isDisabled) Sets whether the user is disabled.
void	setFamilyName(java.lang.String familyName) Sets the user's family name.
void	setGivenName(java.lang.String givenName) Sets the user's given name.
void	setInitials(java.lang.String initials) Sets the user's initials.
void	setLocale(java.util.Locale locale) Sets the user's locale.
void	setPostalAddress(java.lang.String postalAddress) Sets the user's postal address.
void	setTelephoneNumber(java.lang.String telephoneNumber) Sets the user's telephone number.
void	setTimezone(java.util.TimeZone timezone) Sets the user's time zone.
void	setUserid(java.lang.String userid) Sets the user's login identifier.

Methods inherited from interface com.adobe.idp.um.api.infomodel.Principal

addEmailAlias, clearEmailAlias, getCanonicalName, getCommonName, getDescription, getDirectGroupMemberships, getDomainCommonName, getDomainName, getEmail, getEmailAlias, getGroupMemberships, getOid, getOrg, getPrincipalType, getRoleMembership, getStatus, getTimestampCreated, getTimestampUpdated, getVisibility, isLocal, isLocked, isSystem, setCanonicalName, setCommonName, setDescription, setDomainName, setEmail, setEmailAliases, setIsSystem, setLocked, setOid, setOrg, setPrincipalType, setStatus, setVisibility

Method Detail

getUserid

java.lang.String getUserid()

Retrieves the user identifier.

Returns:

A string value that represents the user identifier.

getFamilyName

java.lang.String getFamilyName()

Retrieves the family name.

Returns:

A string value that specifies the family name.

getGivenName

java.lang.String getGivenName()

Retrieves the given name.

Returns:

A string value that specifies the given name.

getInitials

java.lang.String getInitials()

Retrieves the initials.

Returns:

A string value that specifies the initials.

getLocale

java.util.Locale getLocale()

Retrieves the locale.

Returns:

A string value that specifies the locale.

getPostalAddress

java.lang.String getPostalAddress()

Retrieves the postal address.

Returns:

A string value that specifies the postal address.

getTelephoneNumber

java.lang.String getTelephoneNumber()

Retrieves the telephone number.

Returns:

A string value that specifies the telephone number.

getTimezone

java.util.TimeZone getTimezone()

Retrieves the time zone.

Returns:

A string value that specifies the time zone.

getBusinessCalendarKey

java.lang.String getBusinessCalendarKey()

Retrieves the business Calendar Key.

Returns:

A string value that specifies the business calendar key.

isDisabled

boolean isDisabled()

Determines whether the user is disabled.

Returns:

The value true if the user is disabled, false otherwise.

setUserid

void setUserid(java.lang.String userid)

Sets the user's login identifier.

Parameters:

userid - A string value that specifies the user's login identifier.

setFamilyName

void setFamilyName(java.lang.String familyName)

Sets the user's family name.

Parameters:

familyName - A string value that specifies the user's family name.

setGivenName

void setGivenName(java.lang.String givenName)

Sets the user's given name.

Parameters:

givenName - A string value that specifies the user's given name.

setInitials

void setInitials(java.lang.String initials)

Sets the user's initials.

Parameters:

initials - A string value that specifies the user's initials.

setLocale

void setLocale(java.util.Locale locale)

Sets the user's locale.

Parameters:

locale - A string value that specifies the user's locale.

setPostalAddress

void setPostalAddress(java.lang.String postalAddress)

Sets the user's postal address.

Parameters:

postalAddress - A string value that specifies the user's postal address.

setTelephoneNumber

void setTelephoneNumber(java.lang.String telephoneNumber)

Sets the user's telephone number.

Parameters:

telephoneNumber - A string value that specifies the user's telephone number.

setTimezone

void setTimezone(java.util.TimeZone timezone)

Sets the user's time zone.

Parameters:

timezone - A string value that specifies the user's time zone.

setBusinessCalendarKey

void setBusinessCalendarKey(java.lang.String bizCalKey)

Sets the user's business calender key.

Parameters:

bizCalKey - The users business calender key.

setDisabled

void setDisabled(boolean isDisabled)

Sets whether the user is disabled.

Parameters:

isDisabled - The value true if the user is disabled, false otherwise.