Class UserWrapper

Object
com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<User>
com.liferay.portal.kernel.model.UserWrapper
All Implemented Interfaces:
BaseModel<User>, CTModel<User>, ClassedModel, ExternalReferenceCodeModel, ModelWrapper<User>, MVCCModel, PersistedModel, ShardedModel, StagedModel, User, UserModel, Serializable, Cloneable, Comparable<User>

public class UserWrapper extends BaseModelWrapper<User> implements ModelWrapper<User>, User

This class is a wrapper for User.

Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • UserWrapper

      public UserWrapper(User user)
  • Method Details

    • getModelAttributes

      public Map<String,Object> getModelAttributes()
      Specified by:
      getModelAttributes in interface BaseModel<User>
    • setModelAttributes

      public void setModelAttributes(Map<String,Object> attributes)
      Specified by:
      setModelAttributes in interface BaseModel<User>
    • cloneWithOriginalValues

      public User cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<User>
      Specified by:
      cloneWithOriginalValues in interface UserModel
    • fetchContact

      public Contact fetchContact()
      Specified by:
      fetchContact in interface User
    • fetchPortraitURL

      public String fetchPortraitURL(ThemeDisplay themeDisplay)
      Specified by:
      fetchPortraitURL in interface User
    • getAddresses

      public List<Address> getAddresses()
      Returns the user's addresses.
      Specified by:
      getAddresses in interface User
      Returns:
      the user's addresses
    • 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
    • getAllGroups

      public List<Group> getAllGroups() throws PortalException
      Specified by:
      getAllGroups in interface User
      Throws:
      PortalException
    • getAllRoles

      public List<Role> getAllRoles() throws PortalException
      Specified by:
      getAllRoles in interface User
      Throws:
      PortalException
    • getBirthday

      public Date getBirthday() throws PortalException
      Returns the user's birth date.
      Specified by:
      getBirthday in interface User
      Returns:
      the user's birth date
      Throws:
      PortalException
    • getComments

      public String getComments()
      Returns the comments of this user.
      Specified by:
      getComments in interface UserModel
      Returns:
      the comments of this user
    • getCompanyId

      public long getCompanyId()
      Returns the company ID of this user.
      Specified by:
      getCompanyId in interface ShardedModel
      Specified by:
      getCompanyId in interface StagedModel
      Specified by:
      getCompanyId in interface UserModel
      Returns:
      the company ID of this user
    • getCompanyMx

      public String getCompanyMx() throws PortalException
      Returns the user's company's mail domain.
      Specified by:
      getCompanyMx in interface User
      Returns:
      the user's company's mail domain
      Throws:
      PortalException
    • getContact

      public Contact getContact() throws PortalException
      Returns the user's associated contact.
      Specified by:
      getContact in interface User
      Returns:
      the user's associated contact
      Throws:
      PortalException
      See Also:
    • getContactId

      public long getContactId()
      Returns the contact ID of this user.
      Specified by:
      getContactId in interface UserModel
      Returns:
      the contact ID of this user
    • getCreateDate

      public 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
    • getCtCollectionId

      public long getCtCollectionId()
      Returns the ct collection ID of this user.
      Specified by:
      getCtCollectionId in interface CTModel<User>
      Specified by:
      getCtCollectionId in interface UserModel
      Returns:
      the ct collection ID of this user
    • getDigest

      public String getDigest()
      Returns the digest of this user.
      Specified by:
      getDigest in interface UserModel
      Returns:
      the digest of this user
    • getDigest

      @Deprecated public String getDigest(String password)
      Deprecated.
      As of Cavanaugh (7.4.x), with no direct replacement
      Returns a digest for the user, incorporating the password.
      Specified by:
      getDigest in interface User
      Parameters:
      password - a password to incorporate with the digest
      Returns:
      a digest for the user, incorporating the password
    • getDisplayEmailAddress

      public String getDisplayEmailAddress()
      Returns the user's primary email address, or a blank string if the address is fake.
      Specified by:
      getDisplayEmailAddress in interface User
      Returns:
      the user's primary email address, or a blank string if the address is fake
    • getDisplayURL

      public String getDisplayURL(ThemeDisplay themeDisplay) throws PortalException
      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
    • getDisplayURL

      public String getDisplayURL(ThemeDisplay themeDisplay, boolean privateLayout) throws PortalException
      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
      PortalException
    • getEmailAddress

      public String getEmailAddress()
      Returns the email address of this user.
      Specified by:
      getEmailAddress in interface UserModel
      Returns:
      the email address of this user
    • getEmailAddresses

      public List<EmailAddress> getEmailAddresses()
      Returns the user's email addresses.
      Specified by:
      getEmailAddresses in interface User
      Returns:
      the user's email addresses
    • 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
    • getExternalReferenceCode

      public String getExternalReferenceCode()
      Returns the external reference code of this user.
      Specified by:
      getExternalReferenceCode in interface ExternalReferenceCodeModel
      Specified by:
      getExternalReferenceCode in interface UserModel
      Returns:
      the external reference code 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
    • 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
    • getFemale

      public boolean getFemale() throws PortalException
      Returns true if the user is female.
      Specified by:
      getFemale in interface User
      Returns:
      true if the user is female; false otherwise
      Throws:
      PortalException
    • getFirstName

      public String getFirstName()
      Returns the first name of this user.
      Specified by:
      getFirstName in interface UserModel
      Returns:
      the first name of this user
    • getFullName

      public String getFullName()
      Returns the user's full name.
      Specified by:
      getFullName in interface User
      Returns:
      the user's full name
    • getFullName

      public String getFullName(boolean usePrefix, boolean useSuffix)
      Returns the user's full name.
      Specified by:
      getFullName in interface User
      Returns:
      the user's full name
    • getGoogleUserId

      public String getGoogleUserId()
      Returns the google user ID of this user.
      Specified by:
      getGoogleUserId in interface UserModel
      Returns:
      the google user ID 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
    • getGreeting

      public String getGreeting()
      Returns the greeting of this user.
      Specified by:
      getGreeting in interface UserModel
      Returns:
      the greeting of this user
    • getGroup

      public Group getGroup()
      Specified by:
      getGroup in interface User
    • getGroupId

      public long getGroupId()
      Specified by:
      getGroupId in interface User
    • getGroupIds

      public long[] getGroupIds()
      Specified by:
      getGroupIds in interface User
    • getGroups

      public List<Group> getGroups()
      Specified by:
      getGroups in interface User
    • getInheritedGroups

      public List<Group> getInheritedGroups() throws PortalException
      Specified by:
      getInheritedGroups in interface User
      Throws:
      PortalException
    • getInheritedRoles

      public List<Role> getInheritedRoles() throws PortalException
      Specified by:
      getInheritedRoles in interface User
      Throws:
      PortalException
    • getInheritedSiteGroups

      public List<Group> getInheritedSiteGroups() throws PortalException
      Specified by:
      getInheritedSiteGroups in interface User
      Throws:
      PortalException
    • getInheritedSiteRoles

      public List<Role> getInheritedSiteRoles()
      Specified by:
      getInheritedSiteRoles in interface User
    • getInitials

      public String getInitials()
      Specified by:
      getInitials in interface User
    • getJobTitle

      public String getJobTitle()
      Returns the job title of this user.
      Specified by:
      getJobTitle in interface UserModel
      Returns:
      the job title of this user
    • getLanguageId

      public String getLanguageId()
      Returns the language ID of this user.
      Specified by:
      getLanguageId in interface UserModel
      Returns:
      the language ID of this user
    • getLastFailedLoginDate

      public 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
    • getLastLoginDate

      public Date getLastLoginDate()
      Returns the last login date of this user.
      Specified by:
      getLastLoginDate in interface UserModel
      Returns:
      the last login date of this user
    • getLastLoginIP

      public String getLastLoginIP()
      Returns the last login ip of this user.
      Specified by:
      getLastLoginIP in interface UserModel
      Returns:
      the last login ip of this user
    • getLastName

      public String getLastName()
      Returns the last name of this user.
      Specified by:
      getLastName in interface UserModel
      Returns:
      the last name 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
    • getLocale

      public Locale getLocale()
      Specified by:
      getLocale in interface User
    • getLockout

      public boolean getLockout()
      Returns the lockout of this user.
      Specified by:
      getLockout in interface UserModel
      Returns:
      the lockout of this user
    • getLockoutDate

      public Date getLockoutDate()
      Returns the lockout date of this user.
      Specified by:
      getLockoutDate in interface UserModel
      Returns:
      the lockout date of this user
    • getLogin

      public String getLogin() throws PortalException
      Specified by:
      getLogin in interface User
      Throws:
      PortalException
    • getLoginDate

      public Date getLoginDate()
      Returns the login date of this user.
      Specified by:
      getLoginDate in interface UserModel
      Returns:
      the login date of this user
    • getLoginIP

      public String getLoginIP()
      Returns the login ip of this user.
      Specified by:
      getLoginIP in interface UserModel
      Returns:
      the login ip of this user
    • getMale

      public boolean getMale() throws PortalException
      Returns true if the user is male.
      Specified by:
      getMale in interface User
      Returns:
      true if the user is male; false otherwise
      Throws:
      PortalException
    • getMiddleName

      public String getMiddleName()
      Returns the middle name of this user.
      Specified by:
      getMiddleName in interface UserModel
      Returns:
      the middle name of this user
    • getModifiedDate

      public 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
    • getMvccVersion

      public long getMvccVersion()
      Returns the mvcc version of this user.
      Specified by:
      getMvccVersion in interface MVCCModel
      Specified by:
      getMvccVersion in interface UserModel
      Returns:
      the mvcc version of this user
    • getMySiteGroups

      public List<Group> getMySiteGroups() throws PortalException
      Specified by:
      getMySiteGroups in interface User
      Throws:
      PortalException
    • getMySiteGroups

      public List<Group> getMySiteGroups(int max) throws PortalException
      Specified by:
      getMySiteGroups in interface User
      Throws:
      PortalException
    • getMySiteGroups

      public List<Group> getMySiteGroups(String[] classNames, int max) throws PortalException
      Specified by:
      getMySiteGroups in interface User
      Throws:
      PortalException
    • getOpenId

      public String getOpenId()
      Returns the open ID of this user.
      Specified by:
      getOpenId in interface UserModel
      Returns:
      the open ID of this user
    • getOrganizationIds

      public long[] getOrganizationIds() throws PortalException
      Specified by:
      getOrganizationIds in interface User
      Throws:
      PortalException
    • getOrganizationIds

      public long[] getOrganizationIds(boolean includeAdministrative) throws PortalException
      Specified by:
      getOrganizationIds in interface User
      Throws:
      PortalException
    • getOrganizations

      public List<Organization> getOrganizations() throws PortalException
      Specified by:
      getOrganizations in interface User
      Throws:
      PortalException
    • getOrganizations

      public List<Organization> getOrganizations(boolean includeAdministrative) throws PortalException
      Specified by:
      getOrganizations in interface User
      Throws:
      PortalException
    • getOrganizations

      public List<Organization> getOrganizations(boolean includeAdministrative, boolean includeParentOrganizations) throws PortalException
      Specified by:
      getOrganizations in interface User
      Throws:
      PortalException
    • getOrganizationsGroups

      public List<Group> getOrganizationsGroups() throws PortalException
      Specified by:
      getOrganizationsGroups in interface User
      Throws:
      PortalException
    • getOrganizationsRoles

      public List<Role> getOrganizationsRoles() throws PortalException
      Specified by:
      getOrganizationsRoles in interface User
      Throws:
      PortalException
    • getOriginalEmailAddress

      public String getOriginalEmailAddress()
      Specified by:
      getOriginalEmailAddress in interface User
    • getPassword

      public String getPassword()
      Returns the password of this user.
      Specified by:
      getPassword in interface UserModel
      Returns:
      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
    • getPasswordModified

      public boolean getPasswordModified()
      Specified by:
      getPasswordModified in interface User
    • getPasswordModifiedDate

      public Date getPasswordModifiedDate()
      Returns the password modified date of this user.
      Specified by:
      getPasswordModifiedDate in interface UserModel
      Returns:
      the password modified date of this user
    • getPasswordPolicy

      public PasswordPolicy getPasswordPolicy() throws PortalException
      Specified by:
      getPasswordPolicy in interface User
      Throws:
      PortalException
    • getPasswordReset

      public boolean getPasswordReset()
      Returns the password reset of this user.
      Specified by:
      getPasswordReset in interface UserModel
      Returns:
      the password reset of this user
    • getPasswordUnencrypted

      public String getPasswordUnencrypted()
      Specified by:
      getPasswordUnencrypted in interface User
    • getPhones

      public List<Phone> getPhones()
      Specified by:
      getPhones in interface 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
    • getPortraitURL

      public String getPortraitURL(ThemeDisplay themeDisplay) throws PortalException
      Specified by:
      getPortraitURL in interface User
      Throws:
      PortalException
    • getPrimaryKey

      public long getPrimaryKey()
      Returns the primary key of this user.
      Specified by:
      getPrimaryKey in interface CTModel<User>
      Specified by:
      getPrimaryKey in interface UserModel
      Returns:
      the primary key of this user
    • getPrivateLayoutsPageCount

      public int getPrivateLayoutsPageCount() throws PortalException
      Specified by:
      getPrivateLayoutsPageCount in interface User
      Throws:
      PortalException
    • getPublicLayoutsPageCount

      public int getPublicLayoutsPageCount() throws PortalException
      Specified by:
      getPublicLayoutsPageCount in interface User
      Throws:
      PortalException
    • getReminderQueryAnswer

      public String getReminderQueryAnswer()
      Returns the reminder query answer of this user.
      Specified by:
      getReminderQueryAnswer in interface UserModel
      Returns:
      the reminder query answer of this user
    • getReminderQueryQuestion

      public String getReminderQueryQuestion()
      Returns the reminder query question of this user.
      Specified by:
      getReminderQueryQuestion in interface UserModel
      Returns:
      the reminder query question of this user
    • getReminderQueryQuestions

      public Set<String> getReminderQueryQuestions() throws PortalException
      Specified by:
      getReminderQueryQuestions in interface User
      Throws:
      PortalException
    • getRoleIds

      public long[] getRoleIds()
      Specified by:
      getRoleIds in interface User
    • getRoles

      public List<Role> getRoles()
      Specified by:
      getRoles in interface User
    • getScreenName

      public String getScreenName()
      Returns the screen name of this user.
      Specified by:
      getScreenName in interface UserModel
      Returns:
      the screen name of this user
    • getSiteGroups

      public List<Group> getSiteGroups() throws PortalException
      Specified by:
      getSiteGroups in interface User
      Throws:
      PortalException
    • getSiteGroups

      public List<Group> getSiteGroups(boolean includeAdministrative) throws PortalException
      Specified by:
      getSiteGroups in interface User
      Throws:
      PortalException
    • getSiteRoles

      public List<Role> getSiteRoles() throws PortalException
      Specified by:
      getSiteRoles in interface User
      Throws:
      PortalException
    • getStatus

      public int getStatus()
      Returns the status of this user.
      Specified by:
      getStatus in interface UserModel
      Returns:
      the status of this user
    • getTeamIds

      public long[] getTeamIds()
      Specified by:
      getTeamIds in interface User
    • getTeams

      public List<Team> getTeams()
      Specified by:
      getTeams in interface User
    • getTimeZone

      public TimeZone getTimeZone()
      Specified by:
      getTimeZone in interface User
    • getTimeZoneId

      public String getTimeZoneId()
      Returns the time zone ID of this user.
      Specified by:
      getTimeZoneId in interface UserModel
      Returns:
      the time zone ID of this user
    • getType

      public int getType()
      Returns the type of this user.
      Specified by:
      getType in interface UserModel
      Returns:
      the type of this user
    • getUnlockDate

      public Date getUnlockDate() throws PortalException
      Specified by:
      getUnlockDate in interface User
      Throws:
      PortalException
    • getUnlockDate

      public Date getUnlockDate(PasswordPolicy passwordPolicy)
      Specified by:
      getUnlockDate in interface User
    • getUserGroupIds

      public long[] getUserGroupIds()
      Specified by:
      getUserGroupIds in interface User
    • getUserGroupRoles

      public List<UserGroupRole> getUserGroupRoles() throws PortalException
      Specified by:
      getUserGroupRoles in interface User
      Throws:
      PortalException
    • getUserGroups

      public List<UserGroup> getUserGroups()
      Specified by:
      getUserGroups in interface 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
    • getUserUuid

      public String getUserUuid()
      Returns the user uuid of this user.
      Specified by:
      getUserUuid in interface UserModel
      Returns:
      the user uuid of this user
    • getUuid

      public 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
    • getWebsites

      public List<Website> getWebsites()
      Specified by:
      getWebsites in interface User
    • hasCompanyMx

      public boolean hasCompanyMx() throws PortalException
      Specified by:
      hasCompanyMx in interface User
      Throws:
      PortalException
    • hasCompanyMx

      public boolean hasCompanyMx(String emailAddress) throws PortalException
      Specified by:
      hasCompanyMx in interface User
      Throws:
      PortalException
    • hasMySites

      public boolean hasMySites() throws PortalException
      Specified by:
      hasMySites in interface User
      Throws:
      PortalException
    • hasOrganization

      public boolean hasOrganization()
      Specified by:
      hasOrganization in interface User
    • hasPrivateLayouts

      public boolean hasPrivateLayouts() throws PortalException
      Specified by:
      hasPrivateLayouts in interface User
      Throws:
      PortalException
    • hasPublicLayouts

      public boolean hasPublicLayouts() throws PortalException
      Specified by:
      hasPublicLayouts in interface User
      Throws:
      PortalException
    • hasReminderQuery

      public boolean hasReminderQuery()
      Specified by:
      hasReminderQuery in interface User
    • isActive

      public boolean isActive()
      Specified by:
      isActive in interface 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
    • isDefaultUser

      @Deprecated public boolean isDefaultUser()
      Deprecated.
      As of Cavanaugh (7.4.x), replaced by isGuestUser()
      Specified by:
      isDefaultUser in interface User
    • isEmailAddressComplete

      public boolean isEmailAddressComplete()
      Specified by:
      isEmailAddressComplete in interface User
    • isEmailAddressVerificationComplete

      public boolean isEmailAddressVerificationComplete()
      Specified by:
      isEmailAddressVerificationComplete in interface 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
    • isFemale

      public boolean isFemale() throws PortalException
      Specified by:
      isFemale in interface User
      Throws:
      PortalException
    • isGuestUser

      public boolean isGuestUser()
      Specified by:
      isGuestUser in interface 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
    • isMale

      public boolean isMale() throws PortalException
      Specified by:
      isMale in interface User
      Throws:
      PortalException
    • isOnDemandUser

      public boolean isOnDemandUser()
      Specified by:
      isOnDemandUser in interface 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
    • isPasswordModified

      public boolean isPasswordModified()
      Specified by:
      isPasswordModified in interface 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
    • isPasswordResetRequired

      public boolean isPasswordResetRequired()
      Specified by:
      isPasswordResetRequired in interface User
    • isReminderQueryComplete

      public boolean isReminderQueryComplete()
      Specified by:
      isReminderQueryComplete in interface User
    • isServiceAccountUser

      public boolean isServiceAccountUser()
      Specified by:
      isServiceAccountUser in interface User
    • isSetupComplete

      public boolean isSetupComplete()
      Specified by:
      isSetupComplete in interface User
    • isTermsOfUseComplete

      public boolean isTermsOfUseComplete()
      Specified by:
      isTermsOfUseComplete in interface User
    • persist

      public void persist()
      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
    • 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
    • setComments

      public void setComments(String comments)
      Sets the comments of this user.
      Specified by:
      setComments in interface UserModel
      Parameters:
      comments - the comments of this user
    • setCompanyId

      public void setCompanyId(long companyId)
      Sets the company ID of this user.
      Specified by:
      setCompanyId in interface ShardedModel
      Specified by:
      setCompanyId in interface StagedModel
      Specified by:
      setCompanyId in interface UserModel
      Parameters:
      companyId - the company ID of this user
    • setContact

      public void setContact(Contact contact)
      Specified by:
      setContact in interface 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
    • setCreateDate

      public void setCreateDate(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
    • setCtCollectionId

      public void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this user.
      Specified by:
      setCtCollectionId in interface CTModel<User>
      Specified by:
      setCtCollectionId in interface UserModel
      Parameters:
      ctCollectionId - the ct collection ID of this user
    • setDigest

      public void setDigest(String digest)
      Sets the digest of this user.
      Specified by:
      setDigest in interface UserModel
      Parameters:
      digest - the digest of this user
    • setEmailAddress

      public void setEmailAddress(String emailAddress)
      Sets the email address of this user.
      Specified by:
      setEmailAddress in interface UserModel
      Parameters:
      emailAddress - the email address of this user
    • 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
    • setExternalReferenceCode

      public void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this user.
      Specified by:
      setExternalReferenceCode in interface ExternalReferenceCodeModel
      Specified by:
      setExternalReferenceCode in interface UserModel
      Parameters:
      externalReferenceCode - the external reference code 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
    • 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
    • setFirstName

      public void setFirstName(String firstName)
      Sets the first name of this user.
      Specified by:
      setFirstName in interface UserModel
      Parameters:
      firstName - the first name of this user
    • setGoogleUserId

      public void setGoogleUserId(String googleUserId)
      Sets the google user ID of this user.
      Specified by:
      setGoogleUserId in interface UserModel
      Parameters:
      googleUserId - the google user ID 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
    • setGreeting

      public void setGreeting(String greeting)
      Sets the greeting of this user.
      Specified by:
      setGreeting in interface UserModel
      Parameters:
      greeting - the greeting of this user
    • setGroup

      public void setGroup(Group group)
      Specified by:
      setGroup in interface User
    • setGroupId

      public void setGroupId(long groupId)
      Specified by:
      setGroupId in interface User
    • setGroupIds

      public void setGroupIds(long[] groupIds)
      Specified by:
      setGroupIds in interface User
    • setJobTitle

      public void setJobTitle(String jobTitle)
      Sets the job title of this user.
      Specified by:
      setJobTitle in interface UserModel
      Parameters:
      jobTitle - the job title of this user
    • setLanguageId

      public void setLanguageId(String languageId)
      Sets the language ID of this user.
      Specified by:
      setLanguageId in interface UserModel
      Parameters:
      languageId - the language ID of this user
    • setLastFailedLoginDate

      public void setLastFailedLoginDate(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
    • setLastLoginDate

      public void setLastLoginDate(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
    • setLastLoginIP

      public void setLastLoginIP(String lastLoginIP)
      Sets the last login ip of this user.
      Specified by:
      setLastLoginIP in interface UserModel
      Parameters:
      lastLoginIP - the last login ip of this user
    • setLastName

      public void setLastName(String lastName)
      Sets the last name of this user.
      Specified by:
      setLastName in interface UserModel
      Parameters:
      lastName - the last name 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
    • 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
    • setLockoutDate

      public void setLockoutDate(Date lockoutDate)
      Sets the lockout date of this user.
      Specified by:
      setLockoutDate in interface UserModel
      Parameters:
      lockoutDate - the lockout date of this user
    • setLoginDate

      public void setLoginDate(Date loginDate)
      Sets the login date of this user.
      Specified by:
      setLoginDate in interface UserModel
      Parameters:
      loginDate - the login date of this user
    • setLoginIP

      public void setLoginIP(String loginIP)
      Sets the login ip of this user.
      Specified by:
      setLoginIP in interface UserModel
      Parameters:
      loginIP - the login ip of this user
    • setMiddleName

      public void setMiddleName(String middleName)
      Sets the middle name of this user.
      Specified by:
      setMiddleName in interface UserModel
      Parameters:
      middleName - the middle name of this user
    • setModifiedDate

      public void setModifiedDate(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
    • setMvccVersion

      public void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this user.
      Specified by:
      setMvccVersion in interface MVCCModel
      Specified by:
      setMvccVersion in interface UserModel
      Parameters:
      mvccVersion - the mvcc version of this user
    • setOpenId

      public void setOpenId(String openId)
      Sets the open ID of this user.
      Specified by:
      setOpenId in interface UserModel
      Parameters:
      openId - the open ID of this user
    • setOrganizationIds

      public void setOrganizationIds(long[] organizationIds)
      Specified by:
      setOrganizationIds in interface User
    • setPassword

      public void setPassword(String password)
      Sets the password of this user.
      Specified by:
      setPassword in interface UserModel
      Parameters:
      password - the password of this user
    • 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
    • setPasswordModified

      public void setPasswordModified(boolean passwordModified)
      Specified by:
      setPasswordModified in interface User
    • setPasswordModifiedDate

      public void setPasswordModifiedDate(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
    • 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
    • setPasswordUnencrypted

      public void setPasswordUnencrypted(String passwordUnencrypted)
      Specified by:
      setPasswordUnencrypted in interface 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
    • setPrimaryKey

      public void setPrimaryKey(long primaryKey)
      Sets the primary key of this user.
      Specified by:
      setPrimaryKey in interface CTModel<User>
      Specified by:
      setPrimaryKey in interface UserModel
      Parameters:
      primaryKey - the primary key of this user
    • setReminderQueryAnswer

      public void setReminderQueryAnswer(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
    • setReminderQueryQuestion

      public void setReminderQueryQuestion(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
    • setRoleIds

      public void setRoleIds(long[] roleIds)
      Specified by:
      setRoleIds in interface User
    • setScreenName

      public void setScreenName(String screenName)
      Sets the screen name of this user.
      Specified by:
      setScreenName in interface UserModel
      Parameters:
      screenName - the screen name 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
    • setTeamIds

      public void setTeamIds(long[] teamIds)
      Specified by:
      setTeamIds in interface User
    • setTimeZoneId

      public void setTimeZoneId(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
    • setType

      public void setType(int type)
      Sets the type of this user.
      Specified by:
      setType in interface UserModel
      Parameters:
      type - the type of this user
    • setUserGroupIds

      public void setUserGroupIds(long[] userGroupIds)
      Specified by:
      setUserGroupIds in interface 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
    • setUserUuid

      public void setUserUuid(String userUuid)
      Sets the user uuid of this user.
      Specified by:
      setUserUuid in interface UserModel
      Parameters:
      userUuid - the user uuid of this user
    • setUuid

      public void setUuid(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
    • toXmlString

      public String toXmlString()
      Specified by:
      toXmlString in interface UserModel
    • getAttributeGetterFunctions

      public Map<String,Function<User,Object>> getAttributeGetterFunctions()
      Specified by:
      getAttributeGetterFunctions in interface BaseModel<User>
    • getAttributeSetterBiConsumers

      public Map<String,BiConsumer<User,Object>> getAttributeSetterBiConsumers()
      Specified by:
      getAttributeSetterBiConsumers in interface BaseModel<User>
    • getStagedModelType

      public StagedModelType getStagedModelType()
      Specified by:
      getStagedModelType in interface StagedModel
    • wrap

      protected UserWrapper wrap(User user)
      Specified by:
      wrap in class BaseModelWrapper<User>