UserWrapper

java.lang.Object
- com.liferay.portal.model.UserWrapper

All Implemented Interfaces:

BaseModel<User>, ClassedModel, ModelWrapper<User>, PersistedModel, StagedModel, User, UserModel, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<User>
```
@ProviderType
public class UserWrapper
extends java.lang.Object
implements User, ModelWrapper<User>
```
This class is a wrapper for User.

Author:

Brian Wing Shun Chan

See Also:
User, Serialized Form
Generated:

Constructor Summary

Constructors
Constructor and Description

UserWrapper(User user)

Constructors
Constructor and Description
`UserWrapper(User user)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addRemotePreference(RemotePreference remotePreference)`
`java.lang.Object`	`clone()` Creates a shallow clone of this model instance.
`int`	`compareTo(User user)`
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<Address>`	`getAddresses()`
`boolean`	`getAgreedToTermsOfUse()` Returns the agreed to terms of use of this user.
`java.util.Date`	`getBirthday()`
`java.lang.String`	`getComments()` Returns the comments of this user.
`long`	`getCompanyId()` Returns the company ID of this user.
`java.lang.String`	`getCompanyMx()`
`Contact`	`getContact()`
`long`	`getContactId()` Returns the contact ID of this user.
`java.util.Date`	`getCreateDate()` Returns the create date of this user.
`boolean`	`getDefaultUser()` Returns the default user of this user.
`java.lang.String`	`getDigest()` Returns the digest of this user.
`java.lang.String`	`getDigest(java.lang.String password)`
`java.lang.String`	`getDisplayEmailAddress()`
`java.lang.String`	`getDisplayURL(java.lang.String portalURL, java.lang.String mainPath)` Deprecated. As of 7.0.0, replaced by `getDisplayURL(ThemeDisplay)`
`java.lang.String`	`getDisplayURL(java.lang.String portalURL, java.lang.String mainPath, boolean privateLayout)` Deprecated. As of 7.0.0, replaced by `getDisplayURL(ThemeDisplay)`
`java.lang.String`	`getDisplayURL(ThemeDisplay themeDisplay)` Returns the user's display URL based on the theme display, discounting the URL of the user's default intranet site home page.
`java.lang.String`	`getDisplayURL(ThemeDisplay themeDisplay, boolean privateLayout)` Returns the user's display URL based on the theme display.
`java.lang.String`	`getEmailAddress()` Returns the email address of this user.
`java.util.List<EmailAddress>`	`getEmailAddresses()` Returns the user's email addresses.
`boolean`	`getEmailAddressVerified()` Returns the email address verified of this user.
`ExpandoBridge`	`getExpandoBridge()` Returns the expando bridge for this model instance.
`long`	`getFacebookId()` Returns the facebook ID of this user.
`int`	`getFailedLoginAttempts()` Returns the failed login attempts of this user.
`boolean`	`getFemale()` Returns `true` if the user is female.
`java.lang.String`	`getFirstName()` Returns the first name of this user.
`java.lang.String`	`getFullName()` Returns the user's full name.
`int`	`getGraceLoginCount()` Returns the grace login count of this user.
`java.lang.String`	`getGreeting()` Returns the greeting of this user.
`Group`	`getGroup()`
`long`	`getGroupId()`
`long[]`	`getGroupIds()`
`java.util.List<Group>`	`getGroups()`
`java.lang.String`	`getJobTitle()` Returns the job title of this user.
`java.lang.String`	`getLanguageId()` Returns the language ID of this user.
`java.util.Date`	`getLastFailedLoginDate()` Returns the last failed login date of this user.
`java.util.Date`	`getLastLoginDate()` Returns the last login date of this user.
`java.lang.String`	`getLastLoginIP()` Returns the last login i p of this user.
`java.lang.String`	`getLastName()` Returns the last name of this user.
`long`	`getLdapServerId()` Returns the ldap server ID of this user.
`java.util.Locale`	`getLocale()`
`boolean`	`getLockout()` Returns the lockout of this user.
`java.util.Date`	`getLockoutDate()` Returns the lockout date of this user.
`java.lang.String`	`getLogin()`
`java.util.Date`	`getLoginDate()` Returns the login date of this user.
`java.lang.String`	`getLoginIP()` Returns the login i p of this user.
`boolean`	`getMale()` Returns `true` if the user is male.
`java.lang.String`	`getMiddleName()` Returns the middle name of this user.
`java.util.Map<java.lang.String,java.lang.Object>`	`getModelAttributes()`
`java.lang.Class<?>`	`getModelClass()`
`java.lang.String`	`getModelClassName()`
`java.util.Date`	`getModifiedDate()` Returns the modified date of this user.
`java.util.List<Group>`	`getMySiteGroups()`
`java.util.List<Group>`	`getMySiteGroups(boolean includeControlPanel, int max)`
`java.util.List<Group>`	`getMySiteGroups(int max)`
`java.util.List<Group>`	`getMySiteGroups(java.lang.String[] classNames, boolean includeControlPanel, int max)`
`java.util.List<Group>`	`getMySiteGroups(java.lang.String[] classNames, int max)`
`java.util.List<Group>`	`getMySites()` Deprecated. As of 6.2.0, replaced by `getMySiteGroups()`
`java.util.List<Group>`	`getMySites(boolean includeControlPanel, int max)` Deprecated. As of 6.2.0, replaced by `getMySiteGroups(boolean, int)`
`java.util.List<Group>`	`getMySites(int max)` Deprecated. As of 6.2.0, replaced by `getMySiteGroups(int)`
`java.util.List<Group>`	`getMySites(java.lang.String[] classNames, boolean includeControlPanel, int max)` Deprecated. As of 6.2.0, replaced by `getMySiteGroups(String[], boolean, int)`
`java.util.List<Group>`	`getMySites(java.lang.String[] classNames, int max)` Deprecated. As of 6.2.0, replaced by `getMySiteGroups(String[], int)`
`java.lang.String`	`getOpenId()` Returns the open ID of this user.
`long[]`	`getOrganizationIds()`
`long[]`	`getOrganizationIds(boolean includeAdministrative)`
`java.util.List<Organization>`	`getOrganizations()`
`java.util.List<Organization>`	`getOrganizations(boolean includeAdministrative)`
`java.lang.String`	`getPassword()` Returns the password of this user.
`boolean`	`getPasswordEncrypted()` Returns the password encrypted of this user.
`boolean`	`getPasswordModified()`
`java.util.Date`	`getPasswordModifiedDate()` Returns the password modified date of this user.
`PasswordPolicy`	`getPasswordPolicy()`
`boolean`	`getPasswordReset()` Returns the password reset of this user.
`java.lang.String`	`getPasswordUnencrypted()`
`java.util.List<Phone>`	`getPhones()`
`long`	`getPortraitId()` Returns the portrait ID of this user.
`java.lang.String`	`getPortraitURL(ThemeDisplay themeDisplay)`
`long`	`getPrimaryKey()` Returns the primary key of this user.
`java.io.Serializable`	`getPrimaryKeyObj()` Returns the primary key of this model instance.
`int`	`getPrivateLayoutsPageCount()`
`int`	`getPublicLayoutsPageCount()`
`java.lang.String`	`getReminderQueryAnswer()` Returns the reminder query answer of this user.
`java.lang.String`	`getReminderQueryQuestion()` Returns the reminder query question of this user.
`java.util.Set<java.lang.String>`	`getReminderQueryQuestions()`
`RemotePreference`	`getRemotePreference(java.lang.String name)`
`java.lang.Iterable<RemotePreference>`	`getRemotePreferences()`
`long[]`	`getRoleIds()`
`java.util.List<Role>`	`getRoles()`
`java.lang.String`	`getScreenName()` Returns the screen name of this user.
`java.util.List<Group>`	`getSiteGroups()`
`java.util.List<Group>`	`getSiteGroups(boolean includeAdministrative)`
`StagedModelType`	`getStagedModelType()`
`int`	`getStatus()` Returns the status of this user.
`long[]`	`getTeamIds()`
`java.util.List<Team>`	`getTeams()`
`java.util.TimeZone`	`getTimeZone()`
`java.lang.String`	`getTimeZoneId()` Returns the time zone ID of this user.
`long[]`	`getUserGroupIds()`
`java.util.List<UserGroup>`	`getUserGroups()`
`long`	`getUserId()` Returns the user ID of this user.
`java.lang.String`	`getUserUuid()` Returns the user uuid of this user.
`java.lang.String`	`getUuid()` Returns the uuid of this user.
`java.util.List<Website>`	`getWebsites()`
`User`	`getWrappedModel()`
`User`	`getWrappedUser()` Deprecated. As of 6.1.0, replaced by `getWrappedModel()`
`boolean`	`hasCompanyMx()`
`boolean`	`hasCompanyMx(java.lang.String emailAddress)`
`int`	`hashCode()`
`boolean`	`hasMySites()`
`boolean`	`hasOrganization()`
`boolean`	`hasPrivateLayouts()`
`boolean`	`hasPublicLayouts()`
`boolean`	`hasReminderQuery()`
`boolean`	`isActive()`
`boolean`	`isAgreedToTermsOfUse()` Returns `true` if this user is agreed to terms of use.
`boolean`	`isCachedModel()` Returns `true` if this model instance was retrieved from the entity cache.
`boolean`	`isDefaultUser()` Returns `true` if this user is default user.
`boolean`	`isEmailAddressComplete()`
`boolean`	`isEmailAddressVerificationComplete()`
`boolean`	`isEmailAddressVerified()` Returns `true` if this user is email address verified.
`boolean`	`isEscapedModel()` Returns `true` if this model instance is escaped.
`boolean`	`isFemale()`
`boolean`	`isLockout()` Returns `true` if this user is lockout.
`boolean`	`isMale()`
`boolean`	`isNew()` Returns `true` if this model instance does not yet exist in the database.
`boolean`	`isPasswordEncrypted()` Returns `true` if this user is password encrypted.
`boolean`	`isPasswordModified()`
`boolean`	`isPasswordReset()` Returns `true` if this user is password reset.
`boolean`	`isReminderQueryComplete()`
`boolean`	`isSetupComplete()`
`boolean`	`isTermsOfUseComplete()`
`void`	`persist()` Updates this model instance in the database or adds it if it does not yet exist.
`void`	`resetOriginalValues()` Reset all original fields to current values.
`void`	`setAgreedToTermsOfUse(boolean agreedToTermsOfUse)` Sets whether this user is agreed to terms of use.
`void`	`setCachedModel(boolean cachedModel)` Sets whether this model instance was retrieved from the entity cache.
`void`	`setComments(java.lang.String comments)` Sets the comments of this user.
`void`	`setCompanyId(long companyId)` Sets the company ID of this user.
`void`	`setContactId(long contactId)` Sets the contact ID of this user.
`void`	`setCreateDate(java.util.Date createDate)` Sets the create date of this user.
`void`	`setDefaultUser(boolean defaultUser)` Sets whether this user is default user.
`void`	`setDigest(java.lang.String digest)` Sets the digest of this user.
`void`	`setEmailAddress(java.lang.String emailAddress)` Sets the email address of this user.
`void`	`setEmailAddressVerified(boolean emailAddressVerified)` Sets whether this user is email address verified.
`void`	`setExpandoBridgeAttributes(BaseModel<?> baseModel)`
`void`	`setExpandoBridgeAttributes(ExpandoBridge expandoBridge)`
`void`	`setExpandoBridgeAttributes(ServiceContext serviceContext)` Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
`void`	`setFacebookId(long facebookId)` Sets the facebook ID of this user.
`void`	`setFailedLoginAttempts(int failedLoginAttempts)` Sets the failed login attempts of this user.
`void`	`setFirstName(java.lang.String firstName)` Sets the first name of this user.
`void`	`setGraceLoginCount(int graceLoginCount)` Sets the grace login count of this user.
`void`	`setGreeting(java.lang.String greeting)` Sets the greeting of this user.
`void`	`setJobTitle(java.lang.String jobTitle)` Sets the job title of this user.
`void`	`setLanguageId(java.lang.String languageId)` Sets the language ID of this user.
`void`	`setLastFailedLoginDate(java.util.Date lastFailedLoginDate)` Sets the last failed login date of this user.
`void`	`setLastLoginDate(java.util.Date lastLoginDate)` Sets the last login date of this user.
`void`	`setLastLoginIP(java.lang.String lastLoginIP)` Sets the last login i p of this user.
`void`	`setLastName(java.lang.String lastName)` Sets the last name of this user.
`void`	`setLdapServerId(long ldapServerId)` Sets the ldap server ID of this user.
`void`	`setLockout(boolean lockout)` Sets whether this user is lockout.
`void`	`setLockoutDate(java.util.Date lockoutDate)` Sets the lockout date of this user.
`void`	`setLoginDate(java.util.Date loginDate)` Sets the login date of this user.
`void`	`setLoginIP(java.lang.String loginIP)` Sets the login i p of this user.
`void`	`setMiddleName(java.lang.String middleName)` Sets the middle name of this user.
`void`	`setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)`
`void`	`setModifiedDate(java.util.Date modifiedDate)` Sets the modified date of this user.
`void`	`setNew(boolean n)` Sets whether this model instance does not yet exist in the database.
`void`	`setOpenId(java.lang.String openId)` Sets the open ID of this user.
`void`	`setPassword(java.lang.String password)` Sets the password of this user.
`void`	`setPasswordEncrypted(boolean passwordEncrypted)` Sets whether this user is password encrypted.
`void`	`setPasswordModified(boolean passwordModified)`
`void`	`setPasswordModifiedDate(java.util.Date passwordModifiedDate)` Sets the password modified date of this user.
`void`	`setPasswordReset(boolean passwordReset)` Sets whether this user is password reset.
`void`	`setPasswordUnencrypted(java.lang.String passwordUnencrypted)`
`void`	`setPortraitId(long portraitId)` Sets the portrait ID of this user.
`void`	`setPrimaryKey(long primaryKey)` Sets the primary key of this user.
`void`	`setPrimaryKeyObj(java.io.Serializable primaryKeyObj)` Sets the primary key of this model instance.
`void`	`setReminderQueryAnswer(java.lang.String reminderQueryAnswer)` Sets the reminder query answer of this user.
`void`	`setReminderQueryQuestion(java.lang.String reminderQueryQuestion)` Sets the reminder query question of this user.
`void`	`setScreenName(java.lang.String screenName)` Sets the screen name of this user.
`void`	`setStatus(int status)` Sets the status of this user.
`void`	`setTimeZoneId(java.lang.String timeZoneId)` Sets the time zone ID of this user.
`void`	`setUserId(long userId)` Sets the user ID of this user.
`void`	`setUserUuid(java.lang.String userUuid)` Sets the user uuid of this user.
`void`	`setUuid(java.lang.String uuid)` Sets the uuid of this user.
`CacheModel<User>`	`toCacheModel()` Returns a cache model object for this entity used by entity cache.
`User`	`toEscapedModel()` Returns a copy of this entity as an escaped model instance by wrapping it with an `AutoEscapeBeanHandler`.
`java.lang.String`	`toString()`
`User`	`toUnescapedModel()`
`java.lang.String`	`toXmlString()` Returns the XML representation of this model instance.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserWrapper
```
public UserWrapper(User user)
```
- Method Detail
  - getModelClass
```
public java.lang.Class<?> getModelClass()
```
    Specified by:
    
    getModelClass in interface ClassedModel
  - getModelClassName
```
public java.lang.String getModelClassName()
```
    Specified by:
    
    getModelClassName in interface ClassedModel
  - getModelAttributes
```
public java.util.Map<java.lang.String,java.lang.Object> getModelAttributes()
```
    Specified by:
    
    getModelAttributes in interface BaseModel<User>
  - setModelAttributes
```
public void setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
```
    Specified by:
    
    setModelAttributes in interface BaseModel<User>
  - getPrimaryKey
```
public long getPrimaryKey()
```
    Returns the primary key of this user.
    
    Specified by:
    
    getPrimaryKey in interface UserModel
    
    Returns:
    the primary key of this user
  - setPrimaryKey
```
public void setPrimaryKey(long primaryKey)
```
    Sets the primary key of this user.
    
    Specified by:
    
    setPrimaryKey in interface UserModel
    
    Parameters:
    primaryKey - the primary key of this user
  - getUuid
```
public java.lang.String getUuid()
```
    Returns the uuid of this user.
    
    Specified by:
    
    getUuid in interface StagedModel
    
    Specified by:
    
    getUuid in interface UserModel
    
    Returns:
    the uuid of this user
  - setUuid
```
public void setUuid(java.lang.String uuid)
```
    Sets the uuid of this user.
    
    Specified by:
    
    setUuid in interface StagedModel
    
    Specified by:
    
    setUuid in interface UserModel
    
    Parameters:
    uuid - the uuid of this user
  - getUserId
```
public long getUserId()
```
    Returns the user ID of this user.
    
    Specified by:
    
    getUserId in interface UserModel
    
    Returns:
    the user ID of this user
  - setUserId
```
public void setUserId(long userId)
```
    Sets the user ID of this user.
    
    Specified by:
    
    setUserId in interface UserModel
    
    Parameters:
    userId - the user ID of this user
  - getUserUuid
```
public java.lang.String getUserUuid()
                             throws SystemException
```
    Returns the user uuid of this user.
    
    Specified by:
    
    getUserUuid in interface UserModel
    
    Returns:
    the user uuid of this user
    
    Throws:
    
    SystemException - if a system exception occurred
  - setUserUuid
```
public void setUserUuid(java.lang.String userUuid)
```
    Sets the user uuid of this user.
    
    Specified by:
    
    setUserUuid in interface UserModel
    
    Parameters:
    userUuid - the user uuid of this user
  - getCompanyId
```
public long getCompanyId()
```
    Returns the company ID of this user.
    
    Specified by:
    
    getCompanyId in interface StagedModel
    
    Specified by:
    
    getCompanyId in interface UserModel
    
    Returns:
    the company ID of this user
  - setCompanyId
```
public void setCompanyId(long companyId)
```
    Sets the company ID of this user.
    
    Specified by:
    
    setCompanyId in interface StagedModel
    
    Specified by:
    
    setCompanyId in interface UserModel
    
    Parameters:
    companyId - the company ID of this user
  - getCreateDate
```
public java.util.Date getCreateDate()
```
    Returns the create date of this user.
    
    Specified by:
    
    getCreateDate in interface StagedModel
    
    Specified by:
    
    getCreateDate in interface UserModel
    
    Returns:
    the create date of this user
  - setCreateDate
```
public void setCreateDate(java.util.Date createDate)
```
    Sets the create date of this user.
    
    Specified by:
    
    setCreateDate in interface StagedModel
    
    Specified by:
    
    setCreateDate in interface UserModel
    
    Parameters:
    createDate - the create date of this user
  - getModifiedDate
```
public java.util.Date getModifiedDate()
```
    Returns the modified date of this user.
    
    Specified by:
    
    getModifiedDate in interface StagedModel
    
    Specified by:
    
    getModifiedDate in interface UserModel
    
    Returns:
    the modified date of this user
  - setModifiedDate
```
public void setModifiedDate(java.util.Date modifiedDate)
```
    Sets the modified date of this user.
    
    Specified by:
    
    setModifiedDate in interface StagedModel
    
    Specified by:
    
    setModifiedDate in interface UserModel
    
    Parameters:
    modifiedDate - the modified date of this user
  - getDefaultUser
```
public boolean getDefaultUser()
```
    Returns the default user of this user.
    
    Specified by:
    
    getDefaultUser in interface UserModel
    
    Returns:
    the default user of this user
  - isDefaultUser
```
public boolean isDefaultUser()
```
    Returns true if this user is default user.
    
    Specified by:
    
    isDefaultUser in interface UserModel
    
    Returns:
    true if this user is default user; false otherwise
  - setDefaultUser
```
public void setDefaultUser(boolean defaultUser)
```
    Sets whether this user is default user.
    
    Specified by:
    
    setDefaultUser in interface UserModel
    
    Parameters:
    defaultUser - the default user of this user
  - getContactId
```
public long getContactId()
```
    Returns the contact ID of this user.
    
    Specified by:
    
    getContactId in interface UserModel
    
    Returns:
    the contact ID of this user
  - setContactId
```
public void setContactId(long contactId)
```
    Sets the contact ID of this user.
    
    Specified by:
    
    setContactId in interface UserModel
    
    Parameters:
    contactId - the contact ID of this user
  - getPassword
```
public java.lang.String getPassword()
```
    Returns the password of this user.
    
    Specified by:
    
    getPassword in interface UserModel
    
    Returns:
    the password of this user
  - setPassword
```
public void setPassword(java.lang.String password)
```
    Sets the password of this user.
    
    Specified by:
    
    setPassword in interface UserModel
    
    Parameters:
    password - the password of this user
  - getPasswordEncrypted
```
public boolean getPasswordEncrypted()
```
    Returns the password encrypted of this user.
    
    Specified by:
    
    getPasswordEncrypted in interface UserModel
    
    Returns:
    the password encrypted of this user
  - isPasswordEncrypted
```
public boolean isPasswordEncrypted()
```
    Returns true if this user is password encrypted.
    
    Specified by:
    
    isPasswordEncrypted in interface UserModel
    
    Returns:
    true if this user is password encrypted; false otherwise
  - setPasswordEncrypted
```
public void setPasswordEncrypted(boolean passwordEncrypted)
```
    Sets whether this user is password encrypted.
    
    Specified by:
    
    setPasswordEncrypted in interface UserModel
    
    Parameters:
    passwordEncrypted - the password encrypted of this user
  - getPasswordReset
```
public boolean getPasswordReset()
```
    Returns the password reset of this user.
    
    Specified by:
    
    getPasswordReset in interface UserModel
    
    Returns:
    the password reset of this user
  - isPasswordReset
```
public boolean isPasswordReset()
```
    Returns true if this user is password reset.
    
    Specified by:
    
    isPasswordReset in interface UserModel
    
    Returns:
    true if this user is password reset; false otherwise
  - setPasswordReset
```
public void setPasswordReset(boolean passwordReset)
```
    Sets whether this user is password reset.
    
    Specified by:
    
    setPasswordReset in interface UserModel
    
    Parameters:
    passwordReset - the password reset of this user
  - getPasswordModifiedDate
```
public java.util.Date getPasswordModifiedDate()
```
    Returns the password modified date of this user.
    
    Specified by:
    
    getPasswordModifiedDate in interface UserModel
    
    Returns:
    the password modified date of this user
  - setPasswordModifiedDate
```
public void setPasswordModifiedDate(java.util.Date passwordModifiedDate)
```
    Sets the password modified date of this user.
    
    Specified by:
    
    setPasswordModifiedDate in interface UserModel
    
    Parameters:
    passwordModifiedDate - the password modified date of this user
  - getDigest
```
public java.lang.String getDigest()
```
    Returns the digest of this user.
    
    Specified by:
    
    getDigest in interface UserModel
    
    Returns:
    the digest of this user
  - setDigest
```
public void setDigest(java.lang.String digest)
```
    Sets the digest of this user.
    
    Specified by:
    
    setDigest in interface UserModel
    
    Parameters:
    digest - the digest of this user
  - getReminderQueryQuestion
```
public java.lang.String getReminderQueryQuestion()
```
    Returns the reminder query question of this user.
    
    Specified by:
    
    getReminderQueryQuestion in interface UserModel
    
    Returns:
    the reminder query question of this user
  - setReminderQueryQuestion
```
public void setReminderQueryQuestion(java.lang.String reminderQueryQuestion)
```
    Sets the reminder query question of this user.
    
    Specified by:
    
    setReminderQueryQuestion in interface UserModel
    
    Parameters:
    reminderQueryQuestion - the reminder query question of this user
  - getReminderQueryAnswer
```
public java.lang.String getReminderQueryAnswer()
```
    Returns the reminder query answer of this user.
    
    Specified by:
    
    getReminderQueryAnswer in interface UserModel
    
    Returns:
    the reminder query answer of this user
  - setReminderQueryAnswer
```
public void setReminderQueryAnswer(java.lang.String reminderQueryAnswer)
```
    Sets the reminder query answer of this user.
    
    Specified by:
    
    setReminderQueryAnswer in interface UserModel
    
    Parameters:
    reminderQueryAnswer - the reminder query answer of this user
  - getGraceLoginCount
```
public int getGraceLoginCount()
```
    Returns the grace login count of this user.
    
    Specified by:
    
    getGraceLoginCount in interface UserModel
    
    Returns:
    the grace login count of this user
  - setGraceLoginCount
```
public void setGraceLoginCount(int graceLoginCount)
```
    Sets the grace login count of this user.
    
    Specified by:
    
    setGraceLoginCount in interface UserModel
    
    Parameters:
    graceLoginCount - the grace login count of this user
  - getScreenName
```
public java.lang.String getScreenName()
```
    Returns the screen name of this user.
    
    Specified by:
    
    getScreenName in interface UserModel
    
    Returns:
    the screen name of this user
  - setScreenName
```
public void setScreenName(java.lang.String screenName)
```
    Sets the screen name of this user.
    
    Specified by:
    
    setScreenName in interface UserModel
    
    Parameters:
    screenName - the screen name of this user
  - getEmailAddress
```
public java.lang.String getEmailAddress()
```
    Returns the email address of this user.
    
    Specified by:
    
    getEmailAddress in interface UserModel
    
    Returns:
    the email address of this user
  - setEmailAddress
```
public void setEmailAddress(java.lang.String emailAddress)
```
    Sets the email address of this user.
    
    Specified by:
    
    setEmailAddress in interface UserModel
    
    Parameters:
    emailAddress - the email address of this user
  - getFacebookId
```
public long getFacebookId()
```
    Returns the facebook ID of this user.
    
    Specified by:
    
    getFacebookId in interface UserModel
    
    Returns:
    the facebook ID of this user
  - setFacebookId
```
public void setFacebookId(long facebookId)
```
    Sets the facebook ID of this user.
    
    Specified by:
    
    setFacebookId in interface UserModel
    
    Parameters:
    facebookId - the facebook ID of this user
  - getLdapServerId
```
public long getLdapServerId()
```
    Returns the ldap server ID of this user.
    
    Specified by:
    
    getLdapServerId in interface UserModel
    
    Returns:
    the ldap server ID of this user
  - setLdapServerId
```
public void setLdapServerId(long ldapServerId)
```
    Sets the ldap server ID of this user.
    
    Specified by:
    
    setLdapServerId in interface UserModel
    
    Parameters:
    ldapServerId - the ldap server ID of this user
  - getOpenId
```
public java.lang.String getOpenId()
```
    Returns the open ID of this user.
    
    Specified by:
    
    getOpenId in interface UserModel
    
    Returns:
    the open ID of this user
  - setOpenId
```
public void setOpenId(java.lang.String openId)
```
    Sets the open ID of this user.
    
    Specified by:
    
    setOpenId in interface UserModel
    
    Parameters:
    openId - the open ID of this user
  - getPortraitId
```
public long getPortraitId()
```
    Returns the portrait ID of this user.
    
    Specified by:
    
    getPortraitId in interface UserModel
    
    Returns:
    the portrait ID of this user
  - setPortraitId
```
public void setPortraitId(long portraitId)
```
    Sets the portrait ID of this user.
    
    Specified by:
    
    setPortraitId in interface UserModel
    
    Parameters:
    portraitId - the portrait ID of this user
  - getLanguageId
```
public java.lang.String getLanguageId()
```
    Returns the language ID of this user.
    
    Specified by:
    
    getLanguageId in interface UserModel
    
    Returns:
    the language ID of this user
  - setLanguageId
```
public void setLanguageId(java.lang.String languageId)
```
    Sets the language ID of this user.
    
    Specified by:
    
    setLanguageId in interface UserModel
    
    Parameters:
    languageId - the language ID of this user
  - getTimeZoneId
```
public java.lang.String getTimeZoneId()
```
    Returns the time zone ID of this user.
    
    Specified by:
    
    getTimeZoneId in interface UserModel
    
    Returns:
    the time zone ID of this user
  - setTimeZoneId
```
public void setTimeZoneId(java.lang.String timeZoneId)
```
    Sets the time zone ID of this user.
    
    Specified by:
    
    setTimeZoneId in interface UserModel
    
    Parameters:
    timeZoneId - the time zone ID of this user
  - getGreeting
```
public java.lang.String getGreeting()
```
    Returns the greeting of this user.
    
    Specified by:
    
    getGreeting in interface UserModel
    
    Returns:
    the greeting of this user
  - setGreeting
```
public void setGreeting(java.lang.String greeting)
```
    Sets the greeting of this user.
    
    Specified by:
    
    setGreeting in interface UserModel
    
    Parameters:
    greeting - the greeting of this user
  - getComments
```
public java.lang.String getComments()
```
    Returns the comments of this user.
    
    Specified by:
    
    getComments in interface UserModel
    
    Returns:
    the comments of this user
  - setComments
```
public void setComments(java.lang.String comments)
```
    Sets the comments of this user.
    
    Specified by:
    
    setComments in interface UserModel
    
    Parameters:
    comments - the comments of this user
  - getFirstName
```
public java.lang.String getFirstName()
```
    Returns the first name of this user.
    
    Specified by:
    
    getFirstName in interface UserModel
    
    Returns:
    the first name of this user
  - setFirstName
```
public void setFirstName(java.lang.String firstName)
```
    Sets the first name of this user.
    
    Specified by:
    
    setFirstName in interface UserModel
    
    Parameters:
    firstName - the first name of this user
  - getMiddleName
```
public java.lang.String getMiddleName()
```
    Returns the middle name of this user.
    
    Specified by:
    
    getMiddleName in interface UserModel
    
    Returns:
    the middle name of this user
  - setMiddleName
```
public void setMiddleName(java.lang.String middleName)
```
    Sets the middle name of this user.
    
    Specified by:
    
    setMiddleName in interface UserModel
    
    Parameters:
    middleName - the middle name of this user
  - getLastName
```
public java.lang.String getLastName()
```
    Returns the last name of this user.
    
    Specified by:
    
    getLastName in interface UserModel
    
    Returns:
    the last name of this user
  - setLastName
```
public void setLastName(java.lang.String lastName)
```
    Sets the last name of this user.
    
    Specified by:
    
    setLastName in interface UserModel
    
    Parameters:
    lastName - the last name of this user
  - getJobTitle
```
public java.lang.String getJobTitle()
```
    Returns the job title of this user.
    
    Specified by:
    
    getJobTitle in interface UserModel
    
    Returns:
    the job title of this user
  - setJobTitle
```
public void setJobTitle(java.lang.String jobTitle)
```
    Sets the job title of this user.
    
    Specified by:
    
    setJobTitle in interface UserModel
    
    Parameters:
    jobTitle - the job title of this user
  - getLoginDate
```
public java.util.Date getLoginDate()
```
    Returns the login date of this user.
    
    Specified by:
    
    getLoginDate in interface UserModel
    
    Returns:
    the login date of this user
  - setLoginDate
```
public void setLoginDate(java.util.Date loginDate)
```
    Sets the login date of this user.
    
    Specified by:
    
    setLoginDate in interface UserModel
    
    Parameters:
    loginDate - the login date of this user
  - getLoginIP
```
public java.lang.String getLoginIP()
```
    Returns the login i p of this user.
    
    Specified by:
    
    getLoginIP in interface UserModel
    
    Returns:
    the login i p of this user
  - setLoginIP
```
public void setLoginIP(java.lang.String loginIP)
```
    Sets the login i p of this user.
    
    Specified by:
    
    setLoginIP in interface UserModel
    
    Parameters:
    loginIP - the login i p of this user
  - getLastLoginDate
```
public java.util.Date getLastLoginDate()
```
    Returns the last login date of this user.
    
    Specified by:
    
    getLastLoginDate in interface UserModel
    
    Returns:
    the last login date of this user
  - setLastLoginDate
```
public void setLastLoginDate(java.util.Date lastLoginDate)
```
    Sets the last login date of this user.
    
    Specified by:
    
    setLastLoginDate in interface UserModel
    
    Parameters:
    lastLoginDate - the last login date of this user
  - getLastLoginIP
```
public java.lang.String getLastLoginIP()
```
    Returns the last login i p of this user.
    
    Specified by:
    
    getLastLoginIP in interface UserModel
    
    Returns:
    the last login i p of this user
  - setLastLoginIP
```
public void setLastLoginIP(java.lang.String lastLoginIP)
```
    Sets the last login i p of this user.
    
    Specified by:
    
    setLastLoginIP in interface UserModel
    
    Parameters:
    lastLoginIP - the last login i p of this user
  - getLastFailedLoginDate
```
public java.util.Date getLastFailedLoginDate()
```
    Returns the last failed login date of this user.
    
    Specified by:
    
    getLastFailedLoginDate in interface UserModel
    
    Returns:
    the last failed login date of this user
  - setLastFailedLoginDate
```
public void setLastFailedLoginDate(java.util.Date lastFailedLoginDate)
```
    Sets the last failed login date of this user.
    
    Specified by:
    
    setLastFailedLoginDate in interface UserModel
    
    Parameters:
    lastFailedLoginDate - the last failed login date of this user
  - getFailedLoginAttempts
```
public int getFailedLoginAttempts()
```
    Returns the failed login attempts of this user.
    
    Specified by:
    
    getFailedLoginAttempts in interface UserModel
    
    Returns:
    the failed login attempts of this user
  - setFailedLoginAttempts
```
public void setFailedLoginAttempts(int failedLoginAttempts)
```
    Sets the failed login attempts of this user.
    
    Specified by:
    
    setFailedLoginAttempts in interface UserModel
    
    Parameters:
    failedLoginAttempts - the failed login attempts of this user
  - getLockout
```
public boolean getLockout()
```
    Returns the lockout of this user.
    
    Specified by:
    
    getLockout in interface UserModel
    
    Returns:
    the lockout of this user
  - isLockout
```
public boolean isLockout()
```
    Returns true if this user is lockout.
    
    Specified by:
    
    isLockout in interface UserModel
    
    Returns:
    true if this user is lockout; false otherwise
  - setLockout
```
public void setLockout(boolean lockout)
```
    Sets whether this user is lockout.
    
    Specified by:
    
    setLockout in interface UserModel
    
    Parameters:
    lockout - the lockout of this user
  - getLockoutDate
```
public java.util.Date getLockoutDate()
```
    Returns the lockout date of this user.
    
    Specified by:
    
    getLockoutDate in interface UserModel
    
    Returns:
    the lockout date of this user
  - setLockoutDate
```
public void setLockoutDate(java.util.Date lockoutDate)
```
    Sets the lockout date of this user.
    
    Specified by:
    
    setLockoutDate in interface UserModel
    
    Parameters:
    lockoutDate - the lockout date of this user
  - getAgreedToTermsOfUse
```
public boolean getAgreedToTermsOfUse()
```
    Returns the agreed to terms of use of this user.
    
    Specified by:
    
    getAgreedToTermsOfUse in interface UserModel
    
    Returns:
    the agreed to terms of use of this user
  - isAgreedToTermsOfUse
```
public boolean isAgreedToTermsOfUse()
```
    Returns true if this user is agreed to terms of use.
    
    Specified by:
    
    isAgreedToTermsOfUse in interface UserModel
    
    Returns:
    true if this user is agreed to terms of use; false otherwise
  - setAgreedToTermsOfUse
```
public void setAgreedToTermsOfUse(boolean agreedToTermsOfUse)
```
    Sets whether this user is agreed to terms of use.
    
    Specified by:
    
    setAgreedToTermsOfUse in interface UserModel
    
    Parameters:
    agreedToTermsOfUse - the agreed to terms of use of this user
  - getEmailAddressVerified
```
public boolean getEmailAddressVerified()
```
    Returns the email address verified of this user.
    
    Specified by:
    
    getEmailAddressVerified in interface UserModel
    
    Returns:
    the email address verified of this user
  - isEmailAddressVerified
```
public boolean isEmailAddressVerified()
```
    Returns true if this user is email address verified.
    
    Specified by:
    
    isEmailAddressVerified in interface UserModel
    
    Returns:
    true if this user is email address verified; false otherwise
  - setEmailAddressVerified
```
public void setEmailAddressVerified(boolean emailAddressVerified)
```
    Sets whether this user is email address verified.
    
    Specified by:
    
    setEmailAddressVerified in interface UserModel
    
    Parameters:
    emailAddressVerified - the email address verified of this user
  - getStatus
```
public int getStatus()
```
    Returns the status of this user.
    
    Specified by:
    
    getStatus in interface UserModel
    
    Returns:
    the status of this user
  - setStatus
```
public void setStatus(int status)
```
    Sets the status of this user.
    
    Specified by:
    
    setStatus in interface UserModel
    
    Parameters:
    status - the status of this user
  - isNew
```
public boolean isNew()
```
    Description copied from interface: BaseModel
    
    Returns true if this model instance does not yet exist in the database.
    
    Specified by:
    
    isNew in interface BaseModel<User>
    
    Specified by:
    
    isNew in interface UserModel
    
    Returns:
    true if this model instance does not yet exist in the database; false otherwise
  - setNew
```
public void setNew(boolean n)
```
    Description copied from interface: BaseModel
    
    Sets whether this model instance does not yet exist in the database.
    
    Specified by:
    
    setNew in interface BaseModel<User>
    
    Specified by:
    
    setNew in interface UserModel
    
    Parameters:
    n - whether this model instance does not yet exist in the database
  - isCachedModel
```
public boolean isCachedModel()
```
    Description copied from interface: BaseModel
    
    Returns true if this model instance was retrieved from the entity cache.
    
    Specified by:
    
    isCachedModel in interface BaseModel<User>
    
    Specified by:
    
    isCachedModel in interface UserModel
    
    Returns:
    true if this model instance was retrieved from the entity cache; false otherwise
    See Also:
    BaseModel.setCachedModel(boolean)
  - setCachedModel
```
public void setCachedModel(boolean cachedModel)
```
    Description copied from interface: BaseModel
    
    Sets whether this model instance was retrieved from the entity cache.
    
    Specified by:
    
    setCachedModel in interface BaseModel<User>
    
    Specified by:
    
    setCachedModel in interface UserModel
    
    Parameters:
    cachedModel - whether this model instance was retrieved from the entity cache
    See Also:
    EntityCache
  - isEscapedModel
```
public boolean isEscapedModel()
```
    Description copied from interface: BaseModel
    
    Returns true if this model instance is escaped.
    
    Specified by:
    
    isEscapedModel in interface BaseModel<User>
    
    Specified by:
    
    isEscapedModel in interface UserModel
    
    Returns:
    true if this model instance is escaped; false otherwise
  - getPrimaryKeyObj
```
public java.io.Serializable getPrimaryKeyObj()
```
    Description copied from interface: BaseModel
    
    Returns the primary key of this model instance.
    
    Specified by:
    
    getPrimaryKeyObj in interface BaseModel<User>
    
    Specified by:
    
    getPrimaryKeyObj in interface ClassedModel
    
    Specified by:
    
    getPrimaryKeyObj in interface UserModel
    
    Returns:
    the primary key of this model instance
  - setPrimaryKeyObj
```
public void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)
```
    Description copied from interface: BaseModel
    
    Sets the primary key of this model instance.
    
    Specified by:
    
    setPrimaryKeyObj in interface BaseModel<User>
    
    Specified by:
    
    setPrimaryKeyObj in interface ClassedModel
    
    Specified by:
    
    setPrimaryKeyObj in interface UserModel
    
    Parameters:
    primaryKeyObj - the primary key of this model instance
  - getExpandoBridge
```
public ExpandoBridge getExpandoBridge()
```
    Description copied from interface: BaseModel
    
    Returns the expando bridge for this model instance.
    
    Specified by:
    
    getExpandoBridge in interface BaseModel<User>
    
    Specified by:
    
    getExpandoBridge in interface ClassedModel
    
    Specified by:
    
    getExpandoBridge in interface UserModel
    
    Returns:
    the expando bridge for this model instance
  - setExpandoBridgeAttributes
```
public void setExpandoBridgeAttributes(BaseModel<?> baseModel)
```
    Specified by:
    
    setExpandoBridgeAttributes in interface BaseModel<User>
    
    Specified by:
    
    setExpandoBridgeAttributes in interface UserModel
  - setExpandoBridgeAttributes
```
public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
```
    Specified by:
    
    setExpandoBridgeAttributes in interface BaseModel<User>
    
    Specified by:
    
    setExpandoBridgeAttributes in interface UserModel
  - setExpandoBridgeAttributes
```
public void setExpandoBridgeAttributes(ServiceContext serviceContext)
```
    Description copied from interface: BaseModel
    
    Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
    
    Specified by:
    
    setExpandoBridgeAttributes in interface BaseModel<User>
    
    Specified by:
    
    setExpandoBridgeAttributes in interface UserModel
    
    Parameters:
    serviceContext - the service context to be applied
    See Also:
    ServiceContext.getExpandoBridgeAttributes( )
  - clone
```
public java.lang.Object clone()
```
    Description copied from interface: BaseModel
    
    Creates a shallow clone of this model instance.
    
    Specified by:
    
    clone in interface BaseModel<User>
    
    Specified by:
    
    clone in interface StagedModel
    
    Specified by:
    
    clone in interface UserModel
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    the shallow clone of this model instance
  - compareTo
```
public int compareTo(User user)
```
    Specified by:
    
    compareTo in interface UserModel
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<User>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface UserModel
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toCacheModel
```
public CacheModel<User> toCacheModel()
```
    Description copied from interface: BaseModel
    
    Returns a cache model object for this entity used by entity cache.
    
    Specified by:
    
    toCacheModel in interface BaseModel<User>
    
    Specified by:
    
    toCacheModel in interface UserModel
    
    Returns:
    the cache model object
  - toEscapedModel
```
public User toEscapedModel()
```
    Description copied from interface: BaseModel
    
    Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
    
    Specified by:
    
    toEscapedModel in interface BaseModel<User>
    
    Specified by:
    
    toEscapedModel in interface UserModel
    
    Returns:
    the escaped model instance
    See Also:
    AutoEscapeBeanHandler
  - toUnescapedModel
```
public User toUnescapedModel()
```
    Specified by:
    
    toUnescapedModel in interface BaseModel<User>
    
    Specified by:
    
    toUnescapedModel in interface UserModel
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface UserModel
    
    Overrides:
    
    toString in class java.lang.Object
  - toXmlString
```
public java.lang.String toXmlString()
```
    Description copied from interface: BaseModel
    
    Returns the XML representation of this model instance.
    
    Specified by:
    
    toXmlString in interface BaseModel<User>
    
    Specified by:
    
    toXmlString in interface UserModel
    
    Returns:
    the XML representation of this model instance
  - persist
```
public void persist()
             throws SystemException
```
    Description copied from interface: PersistedModel
    
    Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
    
    Specified by:
    
    persist in interface PersistedModel
    
    Throws:
    
    SystemException - if a system exception occurred
  - addRemotePreference
```
public void addRemotePreference(RemotePreference remotePreference)
```
    Specified by:
    
    addRemotePreference in interface User
  - getAddresses
```
public java.util.List<Address> getAddresses()
                                     throws SystemException
```
    Specified by:
    
    getAddresses in interface User
    
    Throws:
    
    SystemException
  - getBirthday
```
public java.util.Date getBirthday()
                           throws PortalException,
                                  SystemException
```
    Specified by:
    
    getBirthday in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getCompanyMx
```
public java.lang.String getCompanyMx()
                              throws PortalException,
                                     SystemException
```
    Specified by:
    
    getCompanyMx in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getContact
```
public Contact getContact()
                   throws PortalException,
                          SystemException
```
    Specified by:
    
    getContact in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getDigest
```
public java.lang.String getDigest(java.lang.String password)
```
    Specified by:
    
    getDigest in interface User
  - getDisplayEmailAddress
```
public java.lang.String getDisplayEmailAddress()
```
    Specified by:
    
    getDisplayEmailAddress in interface User
  - getDisplayURL
```
public java.lang.String getDisplayURL(java.lang.String portalURL,
                             java.lang.String mainPath)
                               throws PortalException,
                                      SystemException
```
    Deprecated. As of 7.0.0, replaced by getDisplayURL(ThemeDisplay)
    Returns the user's display URL, discounting the URL of the user's default intranet site home page.
    The logic for the display URL to return is as follows:
    1. If the user is the guest user, return an empty string.
    2. Else, if a friendly URL is available for the user's profile, return that friendly URL.
    3. Otherwise, return the URL of the user's default extranet site home page.
    Specified by:
    
    getDisplayURL in interface User
    
    Parameters:
    portalURL - the portal's URL
    mainPath - the main path
    
    Returns:
    the user's display URL
    
    Throws:
    
    PortalException - if a portal exception occurred
    
    SystemException - if a system exception occurred
  - getDisplayURL
```
public java.lang.String getDisplayURL(java.lang.String portalURL,
                             java.lang.String mainPath,
                             boolean privateLayout)
                               throws PortalException,
                                      SystemException
```
    Deprecated. As of 7.0.0, replaced by getDisplayURL(ThemeDisplay)
    Returns the user's display URL.
    The logic for the display URL to return is as follows:
    1. If the user is the guest user, return an empty string.
    2. Else, if a friendly URL is available for the user's profile, return that friendly URL.
    3. Else, if privateLayout is true, return the URL of the user's default intranet site home page.
    4. Otherwise, return the URL of the user's default extranet site home page.
    Specified by:
    
    getDisplayURL in interface User
    
    Parameters:
    portalURL - the portal's URL
    mainPath - the main path
    privateLayout - whether to use the URL of the user's default intranet(versus extranet) site home page, if no friendly URL is available for the user's profile
    
    Returns:
    the user's display URL
    
    Throws:
    
    PortalException - if a portal exception occurred
    
    SystemException - if a system exception occurred
  - getDisplayURL
```
public java.lang.String getDisplayURL(ThemeDisplay themeDisplay)
                               throws PortalException,
                                      SystemException
```
    Returns the user's display URL based on the theme display, discounting the URL of the user's default intranet site home page.
    The logic for the display URL to return is as follows:
    1. If the user is the guest user, return an empty string.
    2. Else, if a friendly URL is available for the user's profile, return that friendly URL.
    3. Otherwise, return the URL of the user's default extranet site home page.
    Specified by:
    
    getDisplayURL in interface User
    
    Parameters:
    themeDisplay - the theme display
    
    Returns:
    the user's display URL
    
    Throws:
    
    PortalException - if a portal exception occurred
    
    SystemException - if a system exception occurred
  - getDisplayURL
```
public java.lang.String getDisplayURL(ThemeDisplay themeDisplay,
                             boolean privateLayout)
                               throws PortalException,
                                      SystemException
```
    Returns the user's display URL based on the theme display.
    The logic for the display URL to return is as follows:
    1. If the user is the guest user, return an empty string.
    2. Else, if a friendly URL is available for the user's profile, return that friendly URL.
    3. Else, if privateLayout is true, return the URL of the user's default intranet site home page.
    4. Otherwise, return the URL of the user's default extranet site home page.
    Specified by:
    
    getDisplayURL in interface User
    
    Parameters:
    themeDisplay - the theme display
    privateLayout - whether to use the URL of the user's default intranet (versus extranet) site home page, if no friendly URL is available for the user's profile
    
    Returns:
    the user's display URL
    
    Throws:
    
    PortalException - if a portal exception occurred
    
    SystemException - if a system exception occurred
  - getEmailAddresses
```
public java.util.List<EmailAddress> getEmailAddresses()
                                               throws SystemException
```
    Returns the user's email addresses.
    
    Specified by:
    
    getEmailAddresses in interface User
    
    Returns:
    the user's email addresses
    
    Throws:
    
    SystemException - if a system exception occurred
  - getFemale
```
public boolean getFemale()
                  throws PortalException,
                         SystemException
```
    Returns true if the user is female.
    
    Specified by:
    
    getFemale in interface User
    
    Returns:
    true if the user is female; false otherwise
    
    Throws:
    
    PortalException - if a portal exception occurred
    
    SystemException - if a system exception occurred
  - getFullName
```
public java.lang.String getFullName()
```
    Returns the user's full name.
    
    Specified by:
    
    getFullName in interface User
    
    Returns:
    the user's full name
  - getGroup
```
public Group getGroup()
               throws PortalException,
                      SystemException
```
    Specified by:
    
    getGroup in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getGroupId
```
public long getGroupId()
                throws PortalException,
                       SystemException
```
    Specified by:
    
    getGroupId in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getGroupIds
```
public long[] getGroupIds()
                   throws SystemException
```
    Specified by:
    
    getGroupIds in interface User
    
    Throws:
    
    SystemException
  - getGroups
```
public java.util.List<Group> getGroups()
                                throws SystemException
```
    Specified by:
    
    getGroups in interface User
    
    Throws:
    
    SystemException
  - getLocale
```
public java.util.Locale getLocale()
```
    Specified by:
    
    getLocale in interface User
  - getLogin
```
public java.lang.String getLogin()
                          throws PortalException,
                                 SystemException
```
    Specified by:
    
    getLogin in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getMale
```
public boolean getMale()
                throws PortalException,
                       SystemException
```
    Returns true if the user is male.
    
    Specified by:
    
    getMale in interface User
    
    Returns:
    true if the user is male; false otherwise
    
    Throws:
    
    PortalException - if a portal exception occurred
    
    SystemException - if a system exception occurred
  - getMySiteGroups
```
public java.util.List<Group> getMySiteGroups()
                                      throws PortalException,
                                             SystemException
```
    Specified by:
    
    getMySiteGroups in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getMySiteGroups
```
public java.util.List<Group> getMySiteGroups(boolean includeControlPanel,
                                    int max)
                                      throws PortalException,
                                             SystemException
```
    Specified by:
    
    getMySiteGroups in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getMySiteGroups
```
public java.util.List<Group> getMySiteGroups(int max)
                                      throws PortalException,
                                             SystemException
```
    Specified by:
    
    getMySiteGroups in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getMySiteGroups
```
public java.util.List<Group> getMySiteGroups(java.lang.String[] classNames,
                                    boolean includeControlPanel,
                                    int max)
                                      throws PortalException,
                                             SystemException
```
    Specified by:
    
    getMySiteGroups in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getMySiteGroups
```
public java.util.List<Group> getMySiteGroups(java.lang.String[] classNames,
                                    int max)
                                      throws PortalException,
                                             SystemException
```
    Specified by:
    
    getMySiteGroups in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getMySites
```
public java.util.List<Group> getMySites()
                                 throws PortalException,
                                        SystemException
```
    Deprecated. As of 6.2.0, replaced by getMySiteGroups()
    
    Specified by:
    
    getMySites in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getMySites
```
public java.util.List<Group> getMySites(boolean includeControlPanel,
                               int max)
                                 throws PortalException,
                                        SystemException
```
    Deprecated. As of 6.2.0, replaced by getMySiteGroups(boolean, int)
    
    Specified by:
    
    getMySites in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getMySites
```
public java.util.List<Group> getMySites(int max)
                                 throws PortalException,
                                        SystemException
```
    Deprecated. As of 6.2.0, replaced by getMySiteGroups(int)
    
    Specified by:
    
    getMySites in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getMySites
```
public java.util.List<Group> getMySites(java.lang.String[] classNames,
                               boolean includeControlPanel,
                               int max)
                                 throws PortalException,
                                        SystemException
```
    Deprecated. As of 6.2.0, replaced by getMySiteGroups(String[], boolean, int)
    
    Specified by:
    
    getMySites in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getMySites
```
public java.util.List<Group> getMySites(java.lang.String[] classNames,
                               int max)
                                 throws PortalException,
                                        SystemException
```
    Deprecated. As of 6.2.0, replaced by getMySiteGroups(String[], int)
    
    Specified by:
    
    getMySites in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getOrganizationIds
```
public long[] getOrganizationIds()
                          throws PortalException,
                                 SystemException
```
    Specified by:
    
    getOrganizationIds in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getOrganizationIds
```
public long[] getOrganizationIds(boolean includeAdministrative)
                          throws PortalException,
                                 SystemException
```
    Specified by:
    
    getOrganizationIds in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getOrganizations
```
public java.util.List<Organization> getOrganizations()
                                              throws PortalException,
                                                     SystemException
```
    Specified by:
    
    getOrganizations in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getOrganizations
```
public java.util.List<Organization> getOrganizations(boolean includeAdministrative)
                                              throws PortalException,
                                                     SystemException
```
    Specified by:
    
    getOrganizations in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getPasswordModified
```
public boolean getPasswordModified()
```
    Specified by:
    
    getPasswordModified in interface User
  - getPasswordPolicy
```
public PasswordPolicy getPasswordPolicy()
                                 throws PortalException,
                                        SystemException
```
    Specified by:
    
    getPasswordPolicy in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getPasswordUnencrypted
```
public java.lang.String getPasswordUnencrypted()
```
    Specified by:
    
    getPasswordUnencrypted in interface User
  - getPhones
```
public java.util.List<Phone> getPhones()
                                throws SystemException
```
    Specified by:
    
    getPhones in interface User
    
    Throws:
    
    SystemException
  - getPortraitURL
```
public java.lang.String getPortraitURL(ThemeDisplay themeDisplay)
                                throws PortalException,
                                       SystemException
```
    Specified by:
    
    getPortraitURL in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getPrivateLayoutsPageCount
```
public int getPrivateLayoutsPageCount()
                               throws PortalException,
                                      SystemException
```
    Specified by:
    
    getPrivateLayoutsPageCount in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getPublicLayoutsPageCount
```
public int getPublicLayoutsPageCount()
                              throws PortalException,
                                     SystemException
```
    Specified by:
    
    getPublicLayoutsPageCount in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getReminderQueryQuestions
```
public java.util.Set<java.lang.String> getReminderQueryQuestions()
                                                          throws PortalException,
                                                                 SystemException
```
    Specified by:
    
    getReminderQueryQuestions in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getRemotePreference
```
public RemotePreference getRemotePreference(java.lang.String name)
```
    Specified by:
    
    getRemotePreference in interface User
  - getRemotePreferences
```
public java.lang.Iterable<RemotePreference> getRemotePreferences()
```
    Specified by:
    
    getRemotePreferences in interface User
  - getRoleIds
```
public long[] getRoleIds()
                  throws SystemException
```
    Specified by:
    
    getRoleIds in interface User
    
    Throws:
    
    SystemException
  - getRoles
```
public java.util.List<Role> getRoles()
                              throws SystemException
```
    Specified by:
    
    getRoles in interface User
    
    Throws:
    
    SystemException
  - getSiteGroups
```
public java.util.List<Group> getSiteGroups()
                                    throws PortalException,
                                           SystemException
```
    Specified by:
    
    getSiteGroups in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getSiteGroups
```
public java.util.List<Group> getSiteGroups(boolean includeAdministrative)
                                    throws PortalException,
                                           SystemException
```
    Specified by:
    
    getSiteGroups in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - getTeamIds
```
public long[] getTeamIds()
                  throws SystemException
```
    Specified by:
    
    getTeamIds in interface User
    
    Throws:
    
    SystemException
  - getTeams
```
public java.util.List<Team> getTeams()
                              throws SystemException
```
    Specified by:
    
    getTeams in interface User
    
    Throws:
    
    SystemException
  - getTimeZone
```
public java.util.TimeZone getTimeZone()
```
    Specified by:
    
    getTimeZone in interface User
  - getUserGroupIds
```
public long[] getUserGroupIds()
                       throws SystemException
```
    Specified by:
    
    getUserGroupIds in interface User
    
    Throws:
    
    SystemException
  - getUserGroups
```
public java.util.List<UserGroup> getUserGroups()
                                        throws SystemException
```
    Specified by:
    
    getUserGroups in interface User
    
    Throws:
    
    SystemException
  - getWebsites
```
public java.util.List<Website> getWebsites()
                                    throws SystemException
```
    Specified by:
    
    getWebsites in interface User
    
    Throws:
    
    SystemException
  - hasCompanyMx
```
public boolean hasCompanyMx()
                     throws PortalException,
                            SystemException
```
    Specified by:
    
    hasCompanyMx in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - hasCompanyMx
```
public boolean hasCompanyMx(java.lang.String emailAddress)
                     throws PortalException,
                            SystemException
```
    Specified by:
    
    hasCompanyMx in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - hasMySites
```
public boolean hasMySites()
                   throws PortalException,
                          SystemException
```
    Specified by:
    
    hasMySites in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - hasOrganization
```
public boolean hasOrganization()
                        throws PortalException,
                               SystemException
```
    Specified by:
    
    hasOrganization in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - hasPrivateLayouts
```
public boolean hasPrivateLayouts()
                          throws PortalException,
                                 SystemException
```
    Specified by:
    
    hasPrivateLayouts in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - hasPublicLayouts
```
public boolean hasPublicLayouts()
                         throws PortalException,
                                SystemException
```
    Specified by:
    
    hasPublicLayouts in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - hasReminderQuery
```
public boolean hasReminderQuery()
```
    Specified by:
    
    hasReminderQuery in interface User
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface User
  - isEmailAddressComplete
```
public boolean isEmailAddressComplete()
```
    Specified by:
    
    isEmailAddressComplete in interface User
  - isEmailAddressVerificationComplete
```
public boolean isEmailAddressVerificationComplete()
```
    Specified by:
    
    isEmailAddressVerificationComplete in interface User
  - isFemale
```
public boolean isFemale()
                 throws PortalException,
                        SystemException
```
    Specified by:
    
    isFemale in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - isMale
```
public boolean isMale()
               throws PortalException,
                      SystemException
```
    Specified by:
    
    isMale in interface User
    
    Throws:
    
    PortalException
    
    SystemException
  - isPasswordModified
```
public boolean isPasswordModified()
```
    Specified by:
    
    isPasswordModified in interface User
  - isReminderQueryComplete
```
public boolean isReminderQueryComplete()
```
    Specified by:
    
    isReminderQueryComplete in interface User
  - isSetupComplete
```
public boolean isSetupComplete()
```
    Specified by:
    
    isSetupComplete in interface User
  - isTermsOfUseComplete
```
public boolean isTermsOfUseComplete()
```
    Specified by:
    
    isTermsOfUseComplete in interface User
  - setPasswordModified
```
public void setPasswordModified(boolean passwordModified)
```
    Specified by:
    
    setPasswordModified in interface User
  - setPasswordUnencrypted
```
public void setPasswordUnencrypted(java.lang.String passwordUnencrypted)
```
    Specified by:
    
    setPasswordUnencrypted in interface User
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - getStagedModelType
```
public StagedModelType getStagedModelType()
```
    Specified by:
    
    getStagedModelType in interface StagedModel
  - getWrappedUser
```
public User getWrappedUser()
```
    Deprecated. As of 6.1.0, replaced by getWrappedModel()
  - getWrappedModel
```
public User getWrappedModel()
```
    Specified by:
    
    getWrappedModel in interface ModelWrapper<User>
  - resetOriginalValues
```
public void resetOriginalValues()
```
    Description copied from interface: BaseModel
    
    Reset all original fields to current values.
    
    Specified by:
    
    resetOriginalValues in interface BaseModel<User>

Class UserWrapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserWrapper

Method Detail

getModelClass

getModelClassName

getModelAttributes

setModelAttributes

getPrimaryKey

setPrimaryKey

getUuid

setUuid

getUserId

setUserId

getUserUuid

setUserUuid

getCompanyId

setCompanyId

getCreateDate

setCreateDate

getModifiedDate

setModifiedDate

getDefaultUser

isDefaultUser

setDefaultUser

getContactId

setContactId

getPassword

setPassword

getPasswordEncrypted

isPasswordEncrypted

setPasswordEncrypted

getPasswordReset

isPasswordReset

setPasswordReset

getPasswordModifiedDate

setPasswordModifiedDate

getDigest

setDigest

getReminderQueryQuestion

setReminderQueryQuestion

getReminderQueryAnswer

setReminderQueryAnswer

getGraceLoginCount

setGraceLoginCount

getScreenName

setScreenName

getEmailAddress

setEmailAddress

getFacebookId

setFacebookId

getLdapServerId

setLdapServerId

getOpenId

setOpenId

getPortraitId

setPortraitId

getLanguageId

setLanguageId

getTimeZoneId

setTimeZoneId

getGreeting

setGreeting

getComments

setComments

getFirstName

setFirstName

getMiddleName

setMiddleName

getLastName

setLastName

getJobTitle

setJobTitle

getLoginDate

setLoginDate

getLoginIP

setLoginIP