Liferay 6.0.5

com.liferay.portal.model
Interface UserModel

All Superinterfaces:
BaseModel<User>, Cloneable, Comparable<User>, Serializable
All Known Subinterfaces:
User
All Known Implementing Classes:
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.

Never modify or reference this interface directly. All methods that expect a user model instance should use the User interface instead.

See Also:
User, UserImpl, UserModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(User user)
           
 boolean getActive()
          Gets the active of this user.
 boolean getAgreedToTermsOfUse()
          Gets the agreed to terms of use of this user.
 String getComments()
          Gets the comments of this user.
 long getCompanyId()
          Gets the company id of this user.
 long getContactId()
          Gets the contact id of this user.
 Date getCreateDate()
          Gets the create date of this user.
 boolean getDefaultUser()
          Gets the default user of this user.
 String getDigest()
          Gets the digest of this user.
 String getEmailAddress()
          Gets the email address of this user.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getFacebookId()
          Gets the facebook id of this user.
 int getFailedLoginAttempts()
          Gets the failed login attempts of this user.
 String getFirstName()
          Gets the first name of this user.
 int getGraceLoginCount()
          Gets the grace login count of this user.
 String getGreeting()
          Gets the greeting of this user.
 String getJobTitle()
          Gets the job title of this user.
 String getLanguageId()
          Gets the language id of this user.
 Date getLastFailedLoginDate()
          Gets the last failed login date of this user.
 Date getLastLoginDate()
          Gets the last login date of this user.
 String getLastLoginIP()
          Gets the last login i p of this user.
 String getLastName()
          Gets the last name of this user.
 boolean getLockout()
          Gets the lockout of this user.
 Date getLockoutDate()
          Gets the lockout date of this user.
 Date getLoginDate()
          Gets the login date of this user.
 String getLoginIP()
          Gets the login i p of this user.
 String getMiddleName()
          Gets the middle name of this user.
 Date getModifiedDate()
          Gets the modified date of this user.
 String getOpenId()
          Gets the open id of this user.
 String getPassword()
          Gets the password of this user.
 boolean getPasswordEncrypted()
          Gets the password encrypted of this user.
 Date getPasswordModifiedDate()
          Gets the password modified date of this user.
 boolean getPasswordReset()
          Gets the password reset of this user.
 long getPortraitId()
          Gets the portrait id of this user.
 long getPrimaryKey()
          Gets the primary key of this user.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 String getReminderQueryAnswer()
          Gets the reminder query answer of this user.
 String getReminderQueryQuestion()
          Gets the reminder query question of this user.
 String getScreenName()
          Gets the screen name of this user.
 String getTimeZoneId()
          Gets the time zone id of this user.
 long getUserId()
          Gets the user id of this user.
 String getUserUuid()
          Gets the user uuid of this user.
 String getUuid()
          Gets the uuid of this user.
 int hashCode()
           
 boolean isActive()
          Determines whether this user is active.
 boolean isAgreedToTermsOfUse()
          Determines whether this user is agreed to terms of use.
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isDefaultUser()
          Determines whether this user is default user.
 boolean isEscapedModel()
          Determines if this model instance is escaped.
 boolean isLockout()
          Determines whether this user is lockout.
 boolean isNew()
          Determines if this model instance does not yet exist in the database.
 boolean isPasswordEncrypted()
          Determines whether this user is password encrypted.
 boolean isPasswordReset()
          Determines whether this user is password reset.
 void setActive(boolean active)
          Sets whether this {$entity.humanName} is active.
 void setAgreedToTermsOfUse(boolean agreedToTermsOfUse)
          Sets whether this {$entity.humanName} 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 {$entity.humanName} 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 setEscapedModel(boolean escapedModel)
          Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
 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 {$entity.humanName} 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 {$entity.humanName} is password encrypted.
 void setPasswordModifiedDate(Date passwordModifiedDate)
          Sets the password modified date of this user.
 void setPasswordReset(boolean passwordReset)
          Sets whether this {$entity.humanName} is password reset.
 void setPortraitId(long portraitId)
          Sets the portrait id of this user.
 void setPrimaryKey(long pk)
          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 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.
 User toEscapedModel()
          Gets a copy of this user as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Gets the primary key of this user.

Returns:
the primary key of this user

setPrimaryKey

void setPrimaryKey(long pk)
Sets the primary key of this user

Parameters:
pk - the primary key of this user

getUuid

@AutoEscape
String getUuid()
Gets 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()
Gets 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
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets the default user of this user.

Returns:
the default user of this user

isDefaultUser

boolean isDefaultUser()
Determines whether this user is default user.

Returns:
whether this user is default user

setDefaultUser

void setDefaultUser(boolean defaultUser)
Sets whether this {$entity.humanName} is default user.

Parameters:
defaultUser - the default user of this user

getContactId

long getContactId()
Gets 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()
Gets 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()
Gets the password encrypted of this user.

Returns:
the password encrypted of this user

isPasswordEncrypted

boolean isPasswordEncrypted()
Determines whether this user is password encrypted.

Returns:
whether this user is password encrypted

setPasswordEncrypted

void setPasswordEncrypted(boolean passwordEncrypted)
Sets whether this {$entity.humanName} is password encrypted.

Parameters:
passwordEncrypted - the password encrypted of this user

getPasswordReset

boolean getPasswordReset()
Gets the password reset of this user.

Returns:
the password reset of this user

isPasswordReset

boolean isPasswordReset()
Determines whether this user is password reset.

Returns:
whether this user is password reset

setPasswordReset

void setPasswordReset(boolean passwordReset)
Sets whether this {$entity.humanName} is password reset.

Parameters:
passwordReset - the password reset of this user

getPasswordModifiedDate

Date getPasswordModifiedDate()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets the lockout of this user.

Returns:
the lockout of this user

isLockout

boolean isLockout()
Determines whether this user is lockout.

Returns:
whether this user is lockout

setLockout

void setLockout(boolean lockout)
Sets whether this {$entity.humanName} is lockout.

Parameters:
lockout - the lockout of this user

getLockoutDate

Date getLockoutDate()
Gets 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()
Gets the agreed to terms of use of this user.

Returns:
the agreed to terms of use of this user

isAgreedToTermsOfUse

boolean isAgreedToTermsOfUse()
Determines whether this user is agreed to terms of use.

Returns:
whether this user is agreed to terms of use

setAgreedToTermsOfUse

void setAgreedToTermsOfUse(boolean agreedToTermsOfUse)
Sets whether this {$entity.humanName} is agreed to terms of use.

Parameters:
agreedToTermsOfUse - the agreed to terms of use of this user

getActive

boolean getActive()
Gets the active of this user.

Returns:
the active of this user

isActive

boolean isActive()
Determines whether this user is active.

Returns:
whether this user is active

setActive

void setActive(boolean active)
Sets whether this {$entity.humanName} is active.

Parameters:
active - the active of this user

toEscapedModel

User toEscapedModel()
Gets a copy of this user as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

isNew

boolean isNew()
Description copied from interface: BaseModel
Determines 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
Determines 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
Determines if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<User>
Returns:
true if this model instance is escaped; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, toEscapedModel().

Specified by:
setEscapedModel in interface BaseModel<User>
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Gets the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<User>
Returns:
the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Gets the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<User>
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 to retrieve the expando bridge attributes from
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

toString

String toString()
Overrides:
toString in class Object

toXmlString

String toXmlString()
Description copied from interface: BaseModel
Gets the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<User>
Returns:
the XML representation of this model instance

Liferay 6.0.5