Interface UserModel

All Superinterfaces:
BaseModel<User>, ClassedModel, Cloneable, Comparable<User>, CTModel<User>, ExternalReferenceCodeModel, MVCCModel, Serializable, ShardedModel, StagedModel
All Known Subinterfaces:
User
All Known Implementing Classes:
UserWrapper

@ProviderType public interface UserModel extends BaseModel<User>, CTModel<User>, ExternalReferenceCodeModel, MVCCModel, ShardedModel, StagedModel
The base model interface for the User service. Represents a row in the "User_" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.portal.model.impl.UserModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portal.model.impl.UserImpl.

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

    • getPrimaryKey

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

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

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

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

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

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

      @AutoEscape String getUuid()
      Returns the uuid of this user.
      Specified by:
      getUuid in interface StagedModel
      Returns:
      the uuid of this user
    • setUuid

      void setUuid(String uuid)
      Sets the uuid of this user.
      Specified by:
      setUuid in interface StagedModel
      Parameters:
      uuid - the uuid of this user
    • getExternalReferenceCode

      @AutoEscape String getExternalReferenceCode()
      Returns the external reference code of this user.
      Specified by:
      getExternalReferenceCode in interface ExternalReferenceCodeModel
      Returns:
      the external reference code of this user
    • setExternalReferenceCode

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this user.
      Specified by:
      setExternalReferenceCode in interface ExternalReferenceCodeModel
      Parameters:
      externalReferenceCode - the external reference code of this user
    • getUserId

      long getUserId()
      Returns the user ID of this user.
      Returns:
      the user ID of this user
    • setUserId

      void setUserId(long userId)
      Sets the user ID of this user.
      Parameters:
      userId - the user ID of this user
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this user.
      Returns:
      the user uuid of this user
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this user.
      Parameters:
      userUuid - the user uuid of this user
    • getCompanyId

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

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

      Date getCreateDate()
      Returns the create date of this user.
      Specified by:
      getCreateDate in interface StagedModel
      Returns:
      the create date of this user
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this user.
      Specified by:
      setCreateDate in interface StagedModel
      Parameters:
      createDate - the create date of this user
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this user.
      Specified by:
      getModifiedDate in interface StagedModel
      Returns:
      the modified date of this user
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this user.
      Specified by:
      setModifiedDate in interface StagedModel
      Parameters:
      modifiedDate - the modified date of this user
    • getContactId

      long getContactId()
      Returns the contact ID of this user.
      Returns:
      the contact ID of this user
    • setContactId

      void setContactId(long contactId)
      Sets the contact ID of this user.
      Parameters:
      contactId - the contact ID of this user
    • getPassword

      @AutoEscape String getPassword()
      Returns the password of this user.
      Returns:
      the password of this user
    • setPassword

      void setPassword(String password)
      Sets the password of this user.
      Parameters:
      password - the password of this user
    • getPasswordEncrypted

      boolean getPasswordEncrypted()
      Returns the password encrypted of this user.
      Returns:
      the password encrypted of this user
    • isPasswordEncrypted

      boolean isPasswordEncrypted()
      Returns true if this user is password encrypted.
      Returns:
      true if this user is password encrypted; false otherwise
    • setPasswordEncrypted

      void setPasswordEncrypted(boolean passwordEncrypted)
      Sets whether this user is password encrypted.
      Parameters:
      passwordEncrypted - the password encrypted of this user
    • getPasswordReset

      boolean getPasswordReset()
      Returns the password reset of this user.
      Returns:
      the password reset of this user
    • isPasswordReset

      boolean isPasswordReset()
      Returns true if this user is password reset.
      Returns:
      true if this user is password reset; false otherwise
    • setPasswordReset

      void setPasswordReset(boolean passwordReset)
      Sets whether this user is password reset.
      Parameters:
      passwordReset - the password reset of this user
    • getPasswordModifiedDate

      Date getPasswordModifiedDate()
      Returns the password modified date of this user.
      Returns:
      the password modified date of this user
    • setPasswordModifiedDate

      void setPasswordModifiedDate(Date passwordModifiedDate)
      Sets the password modified date of this user.
      Parameters:
      passwordModifiedDate - the password modified date of this user
    • getDigest

      @AutoEscape String getDigest()
      Returns the digest of this user.
      Returns:
      the digest of this user
    • setDigest

      void setDigest(String digest)
      Sets the digest of this user.
      Parameters:
      digest - the digest of this user
    • getReminderQueryQuestion

      @AutoEscape String getReminderQueryQuestion()
      Returns the reminder query question of this user.
      Returns:
      the reminder query question of this user
    • setReminderQueryQuestion

      void setReminderQueryQuestion(String reminderQueryQuestion)
      Sets the reminder query question of this user.
      Parameters:
      reminderQueryQuestion - the reminder query question of this user
    • getReminderQueryAnswer

      @AutoEscape String getReminderQueryAnswer()
      Returns the reminder query answer of this user.
      Returns:
      the reminder query answer of this user
    • setReminderQueryAnswer

      void setReminderQueryAnswer(String reminderQueryAnswer)
      Sets the reminder query answer of this user.
      Parameters:
      reminderQueryAnswer - the reminder query answer of this user
    • getGraceLoginCount

      int getGraceLoginCount()
      Returns the grace login count of this user.
      Returns:
      the grace login count of this user
    • setGraceLoginCount

      void setGraceLoginCount(int graceLoginCount)
      Sets the grace login count of this user.
      Parameters:
      graceLoginCount - the grace login count of this user
    • getScreenName

      @AutoEscape String getScreenName()
      Returns the screen name of this user.
      Returns:
      the screen name of this user
    • setScreenName

      void setScreenName(String screenName)
      Sets the screen name of this user.
      Parameters:
      screenName - the screen name of this user
    • getEmailAddress

      @AutoEscape String getEmailAddress()
      Returns the email address of this user.
      Returns:
      the email address of this user
    • setEmailAddress

      void setEmailAddress(String emailAddress)
      Sets the email address of this user.
      Parameters:
      emailAddress - the email address of this user
    • getFacebookId

      long getFacebookId()
      Returns the facebook ID of this user.
      Returns:
      the facebook ID of this user
    • setFacebookId

      void setFacebookId(long facebookId)
      Sets the facebook ID of this user.
      Parameters:
      facebookId - the facebook ID of this user
    • getGoogleUserId

      @AutoEscape String getGoogleUserId()
      Returns the google user ID of this user.
      Returns:
      the google user ID of this user
    • setGoogleUserId

      void setGoogleUserId(String googleUserId)
      Sets the google user ID of this user.
      Parameters:
      googleUserId - the google user ID of this user
    • getLdapServerId

      long getLdapServerId()
      Returns the ldap server ID of this user.
      Returns:
      the ldap server ID of this user
    • setLdapServerId

      void setLdapServerId(long ldapServerId)
      Sets the ldap server ID of this user.
      Parameters:
      ldapServerId - the ldap server ID of this user
    • getOpenId

      @AutoEscape String getOpenId()
      Returns the open ID of this user.
      Returns:
      the open ID of this user
    • setOpenId

      void setOpenId(String openId)
      Sets the open ID of this user.
      Parameters:
      openId - the open ID of this user
    • getPortraitId

      long getPortraitId()
      Returns the portrait ID of this user.
      Returns:
      the portrait ID of this user
    • setPortraitId

      void setPortraitId(long portraitId)
      Sets the portrait ID of this user.
      Parameters:
      portraitId - the portrait ID of this user
    • getLanguageId

      @AutoEscape String getLanguageId()
      Returns the language ID of this user.
      Returns:
      the language ID of this user
    • setLanguageId

      void setLanguageId(String languageId)
      Sets the language ID of this user.
      Parameters:
      languageId - the language ID of this user
    • getTimeZoneId

      @AutoEscape String getTimeZoneId()
      Returns the time zone ID of this user.
      Returns:
      the time zone ID of this user
    • setTimeZoneId

      void setTimeZoneId(String timeZoneId)
      Sets the time zone ID of this user.
      Parameters:
      timeZoneId - the time zone ID of this user
    • getGreeting

      @AutoEscape String getGreeting()
      Returns the greeting of this user.
      Returns:
      the greeting of this user
    • setGreeting

      void setGreeting(String greeting)
      Sets the greeting of this user.
      Parameters:
      greeting - the greeting of this user
    • getComments

      @AutoEscape String getComments()
      Returns the comments of this user.
      Returns:
      the comments of this user
    • setComments

      void setComments(String comments)
      Sets the comments of this user.
      Parameters:
      comments - the comments of this user
    • getFirstName

      @AutoEscape String getFirstName()
      Returns the first name of this user.
      Returns:
      the first name of this user
    • setFirstName

      void setFirstName(String firstName)
      Sets the first name of this user.
      Parameters:
      firstName - the first name of this user
    • getMiddleName

      @AutoEscape String getMiddleName()
      Returns the middle name of this user.
      Returns:
      the middle name of this user
    • setMiddleName

      void setMiddleName(String middleName)
      Sets the middle name of this user.
      Parameters:
      middleName - the middle name of this user
    • getLastName

      @AutoEscape String getLastName()
      Returns the last name of this user.
      Returns:
      the last name of this user
    • setLastName

      void setLastName(String lastName)
      Sets the last name of this user.
      Parameters:
      lastName - the last name of this user
    • getJobTitle

      @AutoEscape String getJobTitle()
      Returns the job title of this user.
      Returns:
      the job title of this user
    • setJobTitle

      void setJobTitle(String jobTitle)
      Sets the job title of this user.
      Parameters:
      jobTitle - the job title of this user
    • getLoginDate

      Date getLoginDate()
      Returns the login date of this user.
      Returns:
      the login date of this user
    • setLoginDate

      void setLoginDate(Date loginDate)
      Sets the login date of this user.
      Parameters:
      loginDate - the login date of this user
    • getLoginIP

      @AutoEscape String getLoginIP()
      Returns the login ip of this user.
      Returns:
      the login ip of this user
    • setLoginIP

      void setLoginIP(String loginIP)
      Sets the login ip of this user.
      Parameters:
      loginIP - the login ip of this user
    • getLastLoginDate

      Date getLastLoginDate()
      Returns the last login date of this user.
      Returns:
      the last login date of this user
    • setLastLoginDate

      void setLastLoginDate(Date lastLoginDate)
      Sets the last login date of this user.
      Parameters:
      lastLoginDate - the last login date of this user
    • getLastLoginIP

      @AutoEscape String getLastLoginIP()
      Returns the last login ip of this user.
      Returns:
      the last login ip of this user
    • setLastLoginIP

      void setLastLoginIP(String lastLoginIP)
      Sets the last login ip of this user.
      Parameters:
      lastLoginIP - the last login ip of this user
    • getLastFailedLoginDate

      Date getLastFailedLoginDate()
      Returns the last failed login date of this user.
      Returns:
      the last failed login date of this user
    • setLastFailedLoginDate

      void setLastFailedLoginDate(Date lastFailedLoginDate)
      Sets the last failed login date of this user.
      Parameters:
      lastFailedLoginDate - the last failed login date of this user
    • getFailedLoginAttempts

      int getFailedLoginAttempts()
      Returns the failed login attempts of this user.
      Returns:
      the failed login attempts of this user
    • setFailedLoginAttempts

      void setFailedLoginAttempts(int failedLoginAttempts)
      Sets the failed login attempts of this user.
      Parameters:
      failedLoginAttempts - the failed login attempts of this user
    • getLockout

      boolean getLockout()
      Returns the lockout of this user.
      Returns:
      the lockout of this user
    • isLockout

      boolean isLockout()
      Returns true if this user is lockout.
      Returns:
      true if this user is lockout; false otherwise
    • setLockout

      void setLockout(boolean lockout)
      Sets whether this user is lockout.
      Parameters:
      lockout - the lockout of this user
    • getLockoutDate

      Date getLockoutDate()
      Returns the lockout date of this user.
      Returns:
      the lockout date of this user
    • setLockoutDate

      void setLockoutDate(Date lockoutDate)
      Sets the lockout date of this user.
      Parameters:
      lockoutDate - the lockout date of this user
    • getAgreedToTermsOfUse

      boolean getAgreedToTermsOfUse()
      Returns the agreed to terms of use of this user.
      Returns:
      the agreed to terms of use of this user
    • isAgreedToTermsOfUse

      boolean isAgreedToTermsOfUse()
      Returns true if this user is agreed to terms of use.
      Returns:
      true if this user is agreed to terms of use; false otherwise
    • setAgreedToTermsOfUse

      void setAgreedToTermsOfUse(boolean agreedToTermsOfUse)
      Sets whether this user is agreed to terms of use.
      Parameters:
      agreedToTermsOfUse - the agreed to terms of use of this user
    • getEmailAddressVerified

      boolean getEmailAddressVerified()
      Returns the email address verified of this user.
      Returns:
      the email address verified of this user
    • isEmailAddressVerified

      boolean isEmailAddressVerified()
      Returns true if this user is email address verified.
      Returns:
      true if this user is email address verified; false otherwise
    • setEmailAddressVerified

      void setEmailAddressVerified(boolean emailAddressVerified)
      Sets whether this user is email address verified.
      Parameters:
      emailAddressVerified - the email address verified of this user
    • getType

      int getType()
      Returns the type of this user.
      Returns:
      the type of this user
    • setType

      void setType(int type)
      Sets the type of this user.
      Parameters:
      type - the type of this user
    • getStatus

      int getStatus()
      Returns the status of this user.
      Returns:
      the status of this user
    • setStatus

      void setStatus(int status)
      Sets the status of this user.
      Parameters:
      status - the status of this user
    • cloneWithOriginalValues

      User cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<User>
    • toXmlString

      default String toXmlString()