Package com.liferay.portal.kernel.model
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 Summary
Modifier and TypeMethodDescriptionboolean
Returns the agreed to terms of use of this user.Returns the comments of this user.long
Returns the company ID of this user.long
Returns the contact ID of this user.Returns the create date of this user.long
Returns the ct collection ID of this user.Returns the digest of this user.Returns the email address of this user.boolean
Returns the email address verified of this user.Returns the external reference code of this user.long
Returns the facebook ID of this user.int
Returns the failed login attempts of this user.Returns the first name of this user.Returns the google user ID of this user.int
Returns the grace login count of this user.Returns the greeting of this user.Returns the job title of this user.Returns the language ID of this user.Returns the last failed login date of this user.Returns the last login date of this user.Returns the last login ip of this user.Returns the last name of this user.long
Returns the ldap server ID of this user.boolean
Returns the lockout of this user.Returns the lockout date of this user.Returns the login date of this user.Returns the login ip of this user.Returns the middle name of this user.Returns the modified date of this user.long
Returns the mvcc version of this user.Returns the open ID of this user.Returns the password of this user.boolean
Returns the password encrypted of this user.Returns the password modified date of this user.boolean
Returns the password reset of this user.long
Returns the portrait ID of this user.long
Returns the primary key of this user.Returns the reminder query answer of this user.Returns the reminder query question of this user.Returns the screen name of this user.int
Returns the status of this user.Returns the time zone ID of this user.int
getType()
Returns the type of this user.long
Returns the user ID of this user.Returns the user uuid of this user.getUuid()
Returns the uuid of this user.boolean
Returnstrue
if this user is agreed to terms of use.boolean
Returnstrue
if this user is email address verified.boolean
Returnstrue
if this user is lockout.boolean
Returnstrue
if this user is password encrypted.boolean
Returnstrue
if this user is password reset.void
setAgreedToTermsOfUse
(boolean agreedToTermsOfUse) Sets whether this user is agreed to terms of use.void
setComments
(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
(Date createDate) Sets the create date of this user.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this user.void
Sets the digest of this user.void
setEmailAddress
(String emailAddress) Sets the email address of this user.void
setEmailAddressVerified
(boolean emailAddressVerified) Sets whether this user is email address verified.void
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this user.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
(String firstName) Sets the first name of this user.void
setGoogleUserId
(String googleUserId) Sets the google user ID of this user.void
setGraceLoginCount
(int graceLoginCount) Sets the grace login count of this user.void
setGreeting
(String greeting) Sets the greeting of this user.void
setJobTitle
(String jobTitle) Sets the job title of this user.void
setLanguageId
(String languageId) Sets the language ID of this user.void
setLastFailedLoginDate
(Date lastFailedLoginDate) Sets the last failed login date of this user.void
setLastLoginDate
(Date lastLoginDate) Sets the last login date of this user.void
setLastLoginIP
(String lastLoginIP) Sets the last login ip of this user.void
setLastName
(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
(Date lockoutDate) Sets the lockout date of this user.void
setLoginDate
(Date loginDate) Sets the login date of this user.void
setLoginIP
(String loginIP) Sets the login ip of this user.void
setMiddleName
(String middleName) Sets the middle name of this user.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this user.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this user.void
Sets the open ID of this user.void
setPassword
(String password) Sets the password of this user.void
setPasswordEncrypted
(boolean passwordEncrypted) Sets whether this user is password encrypted.void
setPasswordModifiedDate
(Date passwordModifiedDate) Sets the password modified date of this user.void
setPasswordReset
(boolean passwordReset) Sets whether this user is password reset.void
setPortraitId
(long portraitId) Sets the portrait ID of this user.void
setPrimaryKey
(long primaryKey) Sets the primary key of this user.void
setReminderQueryAnswer
(String reminderQueryAnswer) Sets the reminder query answer of this user.void
setReminderQueryQuestion
(String reminderQueryQuestion) Sets the reminder query question of this user.void
setScreenName
(String screenName) Sets the screen name of this user.void
setStatus
(int status) Sets the status of this user.void
setTimeZoneId
(String timeZoneId) Sets the time zone ID of this user.void
setType
(int type) Sets the type of this user.void
setUserId
(long userId) Sets the user ID of this user.void
setUserUuid
(String userUuid) Sets the user uuid of this user.void
Sets the uuid of this user.default String
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this user.- Specified by:
getPrimaryKey
in interfaceCTModel<User>
- Returns:
- the primary key of this user
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this user.- Specified by:
setPrimaryKey
in interfaceCTModel<User>
- Parameters:
primaryKey
- the primary key of this user
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this user.- Specified by:
getMvccVersion
in interfaceMVCCModel
- Returns:
- the mvcc version of this user
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this user.- Specified by:
setMvccVersion
in interfaceMVCCModel
- Parameters:
mvccVersion
- the mvcc version of this user
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this user.- Specified by:
getCtCollectionId
in interfaceCTModel<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 interfaceCTModel<User>
- Parameters:
ctCollectionId
- the ct collection ID of this user
-
getUuid
Returns the uuid of this user.- Specified by:
getUuid
in interfaceStagedModel
- Returns:
- the uuid of this user
-
setUuid
Sets the uuid of this user.- Specified by:
setUuid
in interfaceStagedModel
- Parameters:
uuid
- the uuid of this user
-
getExternalReferenceCode
Returns the external reference code of this user.- Specified by:
getExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Returns:
- the external reference code of this user
-
setExternalReferenceCode
Sets the external reference code of this user.- Specified by:
setExternalReferenceCode
in interfaceExternalReferenceCodeModel
- 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
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 interfaceShardedModel
- Specified by:
getCompanyId
in interfaceStagedModel
- Returns:
- the company ID of this user
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this user.- Specified by:
setCompanyId
in interfaceShardedModel
- Specified by:
setCompanyId
in interfaceStagedModel
- Parameters:
companyId
- the company ID of this user
-
getCreateDate
Date getCreateDate()Returns the create date of this user.- Specified by:
getCreateDate
in interfaceStagedModel
- Returns:
- the create date of this user
-
setCreateDate
Sets the create date of this user.- Specified by:
setCreateDate
in interfaceStagedModel
- Parameters:
createDate
- the create date of this user
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this user.- Specified by:
getModifiedDate
in interfaceStagedModel
- Returns:
- the modified date of this user
-
setModifiedDate
Sets the modified date of this user.- Specified by:
setModifiedDate
in interfaceStagedModel
- 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
Returns the password of this user.- Returns:
- the password of this user
-
setPassword
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()Returnstrue
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()Returnstrue
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
Sets the password modified date of this user.- Parameters:
passwordModifiedDate
- the password modified date of this user
-
getDigest
Returns the digest of this user.- Returns:
- the digest of this user
-
setDigest
Sets the digest of this user.- Parameters:
digest
- the digest of this user
-
getReminderQueryQuestion
Returns the reminder query question of this user.- Returns:
- the reminder query question of this user
-
setReminderQueryQuestion
Sets the reminder query question of this user.- Parameters:
reminderQueryQuestion
- the reminder query question of this user
-
getReminderQueryAnswer
Returns the reminder query answer of this user.- Returns:
- the reminder query answer of this user
-
setReminderQueryAnswer
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
Returns the screen name of this user.- Returns:
- the screen name of this user
-
setScreenName
Sets the screen name of this user.- Parameters:
screenName
- the screen name of this user
-
getEmailAddress
Returns the email address of this user.- Returns:
- the email address of this user
-
setEmailAddress
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
Returns the google user ID of this user.- Returns:
- the google user ID of this user
-
setGoogleUserId
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
Returns the open ID of this user.- Returns:
- the open ID of this user
-
setOpenId
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
Returns the language ID of this user.- Returns:
- the language ID of this user
-
setLanguageId
Sets the language ID of this user.- Parameters:
languageId
- the language ID of this user
-
getTimeZoneId
Returns the time zone ID of this user.- Returns:
- the time zone ID of this user
-
setTimeZoneId
Sets the time zone ID of this user.- Parameters:
timeZoneId
- the time zone ID of this user
-
getGreeting
Returns the greeting of this user.- Returns:
- the greeting of this user
-
setGreeting
Sets the greeting of this user.- Parameters:
greeting
- the greeting of this user
-
getComments
Returns the comments of this user.- Returns:
- the comments of this user
-
setComments
Sets the comments of this user.- Parameters:
comments
- the comments of this user
-
getFirstName
Returns the first name of this user.- Returns:
- the first name of this user
-
setFirstName
Sets the first name of this user.- Parameters:
firstName
- the first name of this user
-
getMiddleName
Returns the middle name of this user.- Returns:
- the middle name of this user
-
setMiddleName
Sets the middle name of this user.- Parameters:
middleName
- the middle name of this user
-
getLastName
Returns the last name of this user.- Returns:
- the last name of this user
-
setLastName
Sets the last name of this user.- Parameters:
lastName
- the last name of this user
-
getJobTitle
Returns the job title of this user.- Returns:
- the job title of this user
-
setJobTitle
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
Sets the login date of this user.- Parameters:
loginDate
- the login date of this user
-
getLoginIP
Returns the login ip of this user.- Returns:
- the login ip of this user
-
setLoginIP
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
Sets the last login date of this user.- Parameters:
lastLoginDate
- the last login date of this user
-
getLastLoginIP
Returns the last login ip of this user.- Returns:
- the last login ip of this user
-
setLastLoginIP
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
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()Returnstrue
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
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()Returnstrue
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()Returnstrue
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 interfaceBaseModel<User>
-
toXmlString
-