com.liferay.portal.model
Interface UserModel

All Superinterfaces:

BaseModel<User>, ClassedModel, Cloneable, Comparable<User>, Serializable

All Known Subinterfaces:

User

All Known Implementing Classes:

UserBaseImpl, UserImpl, UserModelImpl, UserWrapper

public interface UserModel
extends BaseModel<User>

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 UserModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in UserImpl.

See Also:

User, UserImpl, UserModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(User user)
boolean	getAgreedToTermsOfUse() Returns the agreed to terms of use of this user.
String	getComments() Returns the comments of this user.
long	getCompanyId() Returns the company ID of this user.
long	getContactId() Returns the contact ID of this user.
Date	getCreateDate() Returns the create date of this user.
boolean	getDefaultUser() Returns the default user of this user.
String	getDigest() Returns the digest of this user.
String	getEmailAddress() Returns the email address of this user.
boolean	getEmailAddressVerified() Returns the email address verified of this user.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getFacebookId() Returns the facebook ID of this user.
int	getFailedLoginAttempts() Returns the failed login attempts of this user.
String	getFirstName() Returns the first name of this user.
int	getGraceLoginCount() Returns the grace login count of this user.
String	getGreeting() Returns the greeting of this user.
String	getJobTitle() Returns the job title of this user.
String	getLanguageId() Returns the language ID of this user.
Date	getLastFailedLoginDate() Returns the last failed login date of this user.
Date	getLastLoginDate() Returns the last login date of this user.
String	getLastLoginIP() Returns the last login i p of this user.
String	getLastName() Returns the last name of this user.
boolean	getLockout() Returns the lockout of this user.
Date	getLockoutDate() Returns the lockout date of this user.
Date	getLoginDate() Returns the login date of this user.
String	getLoginIP() Returns the login i p of this user.
String	getMiddleName() Returns the middle name of this user.
Date	getModifiedDate() Returns the modified date of this user.
String	getOpenId() Returns the open ID of this user.
String	getPassword() Returns the password of this user.
boolean	getPasswordEncrypted() Returns the password encrypted of this user.
Date	getPasswordModifiedDate() Returns the password modified date of this user.
boolean	getPasswordReset() Returns the password reset of this user.
long	getPortraitId() Returns the portrait ID of this user.
long	getPrimaryKey() Returns the primary key of this user.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
String	getReminderQueryAnswer() Returns the reminder query answer of this user.
String	getReminderQueryQuestion() Returns the reminder query question of this user.
String	getScreenName() Returns the screen name of this user.
int	getStatus() Returns the status of this user.
String	getTimeZoneId() Returns the time zone ID of this user.
long	getUserId() Returns the user ID of this user.
String	getUserUuid() Returns the user uuid of this user.
String	getUuid() Returns the uuid of this user.
int	hashCode()
boolean	isAgreedToTermsOfUse() Returns true if this user is agreed to terms of use.
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isDefaultUser() Returns true if this user is default user.
boolean	isEmailAddressVerified() Returns true if this user is email address verified.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isLockout() Returns true if this user is lockout.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
boolean	isPasswordEncrypted() Returns true if this user is password encrypted.
boolean	isPasswordReset() Returns true if this user is password reset.
void	setAgreedToTermsOfUse(boolean agreedToTermsOfUse) Sets whether this user is agreed to terms of use.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setComments(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	setDefaultUser(boolean defaultUser) Sets whether this user is default user.
void	setDigest(String digest) 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	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setFacebookId(long facebookId) Sets the facebook ID of this user.
void	setFailedLoginAttempts(int failedLoginAttempts) Sets the failed login attempts of this user.
void	setFirstName(String firstName) Sets the first name 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 i p of this user.
void	setLastName(String lastName) Sets the last name 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 i p 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	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setOpenId(String openId) 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	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
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	setUserId(long userId) Sets the user ID of this user.
void	setUserUuid(String userUuid) Sets the user uuid of this user.
void	setUuid(String uuid) Sets the uuid of this user.
CacheModel<User>	toCacheModel() Returns a cache model object for this entity used by entity cache.
User	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
User	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.model.BaseModel

getModelAttributes, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.model.ClassedModel

getModelClass, getModelClassName

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this user.

Returns:

the primary key of this user

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this user.

Parameters:

primaryKey - the primary key of this user

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this user.

Returns:

the uuid of this user

setUuid

void setUuid(String uuid)

Sets the uuid of this user.

Parameters:

uuid - the uuid 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()
                   throws SystemException

Returns the user uuid of this user.

Returns:

the user uuid of this user

Throws:

SystemException - if a system exception occurred

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.

Returns:

the company ID of this user

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this user.

Parameters:

companyId - the company ID of this user

getCreateDate

Date getCreateDate()

Returns the create date of this user.

Returns:

the create date of this user

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this user.

Parameters:

createDate - the create date of this user

getModifiedDate

Date getModifiedDate()

Returns the modified date of this user.

Returns:

the modified date of this user

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this user.

Parameters:

modifiedDate - the modified date of this user

getDefaultUser

boolean getDefaultUser()

Returns the default user of this user.

Returns:

the default user of this user

isDefaultUser

boolean isDefaultUser()

Returns true if this user is default user.

Returns:

true if this user is default user; false otherwise

setDefaultUser

void setDefaultUser(boolean defaultUser)

Sets whether this user is default user.

Parameters:

defaultUser - the default user 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

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 i p of this user.

Returns:

the login i p of this user

setLoginIP

void setLoginIP(String loginIP)

Sets the login i p of this user.

Parameters:

loginIP - the login i p 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 i p of this user.

Returns:

the last login i p of this user

setLastLoginIP

void setLastLoginIP(String lastLoginIP)

Sets the last login i p of this user.

Parameters:

lastLoginIP - the last login i p 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

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

isNew

boolean isNew()

Description copied from interface: BaseModel

Returns true if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<User>

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

void setNew(boolean n)

Description copied from interface: BaseModel

Sets whether this model instance does not yet exist in the database.

Specified by:

setNew in interface BaseModel<User>

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()

Description copied from interface: BaseModel

Returns true if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<User>

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

void setCachedModel(boolean cachedModel)

Description copied from interface: BaseModel

Sets whether this model instance was retrieved from the entity cache.

Specified by:

setCachedModel in interface BaseModel<User>

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<User>

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<User>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<User>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<User>

Specified by:

getExpandoBridge in interface ClassedModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ServiceContext serviceContext)

Description copied from interface: BaseModel

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:

setExpandoBridgeAttributes in interface BaseModel<User>

Parameters:

serviceContext - the service context

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<User>

Returns:

the shallow clone of this model instance

compareTo

int compareTo(User user)

Specified by:

compareTo in interface Comparable<User>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<User> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<User>

Returns:

the cache model object

toEscapedModel

User toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<User>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

User toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<User>

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<User>

Returns:

the XML representation of this model instance