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 TypeMethodDescriptionbooleanReturns the agreed to terms of use of this user.Returns the comments of this user.longReturns the company ID of this user.longReturns the contact ID of this user.Returns the create date of this user.longReturns the ct collection ID of this user.Returns the digest of this user.Returns the email address of this user.booleanReturns the email address verified of this user.Returns the external reference code of this user.longReturns the facebook ID of this user.intReturns the failed login attempts of this user.Returns the first name of this user.Returns the google user ID of this user.intReturns 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.longReturns the ldap server ID of this user.booleanReturns 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.longReturns the mvcc version of this user.Returns the open ID of this user.Returns the password of this user.booleanReturns the password encrypted of this user.Returns the password modified date of this user.booleanReturns the password reset of this user.longReturns the portrait ID of this user.longReturns 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.intReturns the status of this user.Returns the time zone ID of this user.intgetType()Returns the type of this user.longReturns the user ID of this user.Returns the user uuid of this user.getUuid()Returns the uuid of this user.booleanReturnstrueif this user is agreed to terms of use.booleanReturnstrueif this user is email address verified.booleanReturnstrueif this user is lockout.booleanReturnstrueif this user is password encrypted.booleanReturnstrueif this user is password reset.voidsetAgreedToTermsOfUse(boolean agreedToTermsOfUse) Sets whether this user is agreed to terms of use.voidsetComments(String comments) Sets the comments of this user.voidsetCompanyId(long companyId) Sets the company ID of this user.voidsetContactId(long contactId) Sets the contact ID of this user.voidsetCreateDate(Date createDate) Sets the create date of this user.voidsetCtCollectionId(long ctCollectionId) Sets the ct collection ID of this user.voidSets the digest of this user.voidsetEmailAddress(String emailAddress) Sets the email address of this user.voidsetEmailAddressVerified(boolean emailAddressVerified) Sets whether this user is email address verified.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this user.voidsetFacebookId(long facebookId) Sets the facebook ID of this user.voidsetFailedLoginAttempts(int failedLoginAttempts) Sets the failed login attempts of this user.voidsetFirstName(String firstName) Sets the first name of this user.voidsetGoogleUserId(String googleUserId) Sets the google user ID of this user.voidsetGraceLoginCount(int graceLoginCount) Sets the grace login count of this user.voidsetGreeting(String greeting) Sets the greeting of this user.voidsetJobTitle(String jobTitle) Sets the job title of this user.voidsetLanguageId(String languageId) Sets the language ID of this user.voidsetLastFailedLoginDate(Date lastFailedLoginDate) Sets the last failed login date of this user.voidsetLastLoginDate(Date lastLoginDate) Sets the last login date of this user.voidsetLastLoginIP(String lastLoginIP) Sets the last login ip of this user.voidsetLastName(String lastName) Sets the last name of this user.voidsetLdapServerId(long ldapServerId) Sets the ldap server ID of this user.voidsetLockout(boolean lockout) Sets whether this user is lockout.voidsetLockoutDate(Date lockoutDate) Sets the lockout date of this user.voidsetLoginDate(Date loginDate) Sets the login date of this user.voidsetLoginIP(String loginIP) Sets the login ip of this user.voidsetMiddleName(String middleName) Sets the middle name of this user.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this user.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this user.voidSets the open ID of this user.voidsetPassword(String password) Sets the password of this user.voidsetPasswordEncrypted(boolean passwordEncrypted) Sets whether this user is password encrypted.voidsetPasswordModifiedDate(Date passwordModifiedDate) Sets the password modified date of this user.voidsetPasswordReset(boolean passwordReset) Sets whether this user is password reset.voidsetPortraitId(long portraitId) Sets the portrait ID of this user.voidsetPrimaryKey(long primaryKey) Sets the primary key of this user.voidsetReminderQueryAnswer(String reminderQueryAnswer) Sets the reminder query answer of this user.voidsetReminderQueryQuestion(String reminderQueryQuestion) Sets the reminder query question of this user.voidsetScreenName(String screenName) Sets the screen name of this user.voidsetStatus(int status) Sets the status of this user.voidsetTimeZoneId(String timeZoneId) Sets the time zone ID of this user.voidsetType(int type) Sets the type of this user.voidsetUserId(long userId) Sets the user ID of this user.voidsetUserUuid(String userUuid) Sets the user uuid of this user.voidSets the uuid of this user.default StringMethods 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, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods 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:
getPrimaryKeyin interfaceCTModel<User>- Returns:
- the primary key of this user
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this user.- Specified by:
setPrimaryKeyin interfaceCTModel<User>- Parameters:
primaryKey- the primary key of this user
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this user.- Specified by:
getMvccVersionin interfaceMVCCModel- Returns:
- the mvcc version of this user
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this user.- Specified by:
setMvccVersionin interfaceMVCCModel- Parameters:
mvccVersion- the mvcc version of this user
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this user.- Specified by:
getCtCollectionIdin 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:
setCtCollectionIdin interfaceCTModel<User>- Parameters:
ctCollectionId- the ct collection ID of this user
-
getUuid
Returns the uuid of this user.- Specified by:
getUuidin interfaceStagedModel- Returns:
- the uuid of this user
-
setUuid
Sets the uuid of this user.- Specified by:
setUuidin interfaceStagedModel- Parameters:
uuid- the uuid of this user
-
getExternalReferenceCode
Returns the external reference code of this user.- Specified by:
getExternalReferenceCodein interfaceExternalReferenceCodeModel- Returns:
- the external reference code of this user
-
setExternalReferenceCode
Sets the external reference code of this user.- Specified by:
setExternalReferenceCodein 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:
getCompanyIdin interfaceShardedModel- Specified by:
getCompanyIdin interfaceStagedModel- Returns:
- the company ID of this user
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this user.- Specified by:
setCompanyIdin interfaceShardedModel- Specified by:
setCompanyIdin interfaceStagedModel- Parameters:
companyId- the company ID of this user
-
getCreateDate
Date getCreateDate()Returns the create date of this user.- Specified by:
getCreateDatein interfaceStagedModel- Returns:
- the create date of this user
-
setCreateDate
Sets the create date of this user.- Specified by:
setCreateDatein interfaceStagedModel- Parameters:
createDate- the create date of this user
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this user.- Specified by:
getModifiedDatein interfaceStagedModel- Returns:
- the modified date of this user
-
setModifiedDate
Sets the modified date of this user.- Specified by:
setModifiedDatein 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()Returnstrueif this user is password encrypted.- Returns:
trueif this user is password encrypted;falseotherwise
-
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()Returnstrueif this user is password reset.- Returns:
trueif this user is password reset;falseotherwise
-
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()Returnstrueif this user is lockout.- Returns:
trueif this user is lockout;falseotherwise
-
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()Returnstrueif this user is agreed to terms of use.- Returns:
trueif this user is agreed to terms of use;falseotherwise
-
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()Returnstrueif this user is email address verified.- Returns:
trueif this user is email address verified;falseotherwise
-
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:
cloneWithOriginalValuesin interfaceBaseModel<User>
-
toXmlString
-