Liferay 6.0.3

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>

This interface is a model that represents the User_ table in the database.

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()
           
 boolean getAgreedToTermsOfUse()
           
 String getComments()
           
 long getCompanyId()
           
 long getContactId()
           
 Date getCreateDate()
           
 boolean getDefaultUser()
           
 String getEmailAddress()
           
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getFacebookId()
           
 int getFailedLoginAttempts()
           
 String getFirstName()
           
 int getGraceLoginCount()
           
 String getGreeting()
           
 String getJobTitle()
           
 String getLanguageId()
           
 Date getLastFailedLoginDate()
           
 Date getLastLoginDate()
           
 String getLastLoginIP()
           
 String getLastName()
           
 boolean getLockout()
           
 Date getLockoutDate()
           
 Date getLoginDate()
           
 String getLoginIP()
           
 String getMiddleName()
           
 Date getModifiedDate()
           
 String getOpenId()
           
 String getPassword()
           
 boolean getPasswordEncrypted()
           
 Date getPasswordModifiedDate()
           
 boolean getPasswordReset()
           
 long getPortraitId()
           
 long getPrimaryKey()
           
 Serializable getPrimaryKeyObj()
          Gets the primary key for this model instance.
 String getReminderQueryAnswer()
           
 String getReminderQueryQuestion()
           
 String getScreenName()
           
 String getTimeZoneId()
           
 long getUserId()
           
 String getUserUuid()
           
 String getUuid()
           
 int hashCode()
           
 boolean isActive()
           
 boolean isAgreedToTermsOfUse()
           
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isDefaultUser()
           
 boolean isEscapedModel()
          Determines if this model instance has been wrapped with an HTML auto escape handler.
 boolean isLockout()
           
 boolean isNew()
          Determines if this model instance does not yet exist in the database.
 boolean isPasswordEncrypted()
           
 boolean isPasswordReset()
           
 void setActive(boolean active)
           
 void setAgreedToTermsOfUse(boolean agreedToTermsOfUse)
           
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setComments(String comments)
           
 void setCompanyId(long companyId)
           
 void setContactId(long contactId)
           
 void setCreateDate(Date createDate)
           
 void setDefaultUser(boolean defaultUser)
           
 void setEmailAddress(String emailAddress)
           
 void setEscapedModel(boolean escapedModel)
          Sets whether this model instance has been wrapped with an HTML auto escape handler.
 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)
           
 void setFailedLoginAttempts(int failedLoginAttempts)
           
 void setFirstName(String firstName)
           
 void setGraceLoginCount(int graceLoginCount)
           
 void setGreeting(String greeting)
           
 void setJobTitle(String jobTitle)
           
 void setLanguageId(String languageId)
           
 void setLastFailedLoginDate(Date lastFailedLoginDate)
           
 void setLastLoginDate(Date lastLoginDate)
           
 void setLastLoginIP(String lastLoginIP)
           
 void setLastName(String lastName)
           
 void setLockout(boolean lockout)
           
 void setLockoutDate(Date lockoutDate)
           
 void setLoginDate(Date loginDate)
           
 void setLoginIP(String loginIP)
           
 void setMiddleName(String middleName)
           
 void setModifiedDate(Date modifiedDate)
           
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setOpenId(String openId)
           
 void setPassword(String password)
           
 void setPasswordEncrypted(boolean passwordEncrypted)
           
 void setPasswordModifiedDate(Date passwordModifiedDate)
           
 void setPasswordReset(boolean passwordReset)
           
 void setPortraitId(long portraitId)
           
 void setPrimaryKey(long pk)
           
 void setReminderQueryAnswer(String reminderQueryAnswer)
           
 void setReminderQueryQuestion(String reminderQueryQuestion)
           
 void setScreenName(String screenName)
           
 void setTimeZoneId(String timeZoneId)
           
 void setUserId(long userId)
           
 void setUserUuid(String userUuid)
           
 void setUuid(String uuid)
           
 User toEscapedModel()
           
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 

Method Detail

getPrimaryKey

long getPrimaryKey()

setPrimaryKey

void setPrimaryKey(long pk)

getUuid

String getUuid()

setUuid

void setUuid(String uuid)

getUserId

long getUserId()

setUserId

void setUserId(long userId)

getUserUuid

String getUserUuid()
                   throws SystemException
Throws:
SystemException

setUserUuid

void setUserUuid(String userUuid)

getCompanyId

long getCompanyId()

setCompanyId

void setCompanyId(long companyId)

getCreateDate

Date getCreateDate()

setCreateDate

void setCreateDate(Date createDate)

getModifiedDate

Date getModifiedDate()

setModifiedDate

void setModifiedDate(Date modifiedDate)

getDefaultUser

boolean getDefaultUser()

isDefaultUser

boolean isDefaultUser()

setDefaultUser

void setDefaultUser(boolean defaultUser)

getContactId

long getContactId()

setContactId

void setContactId(long contactId)

getPassword

String getPassword()

setPassword

void setPassword(String password)

getPasswordEncrypted

boolean getPasswordEncrypted()

isPasswordEncrypted

boolean isPasswordEncrypted()

setPasswordEncrypted

void setPasswordEncrypted(boolean passwordEncrypted)

getPasswordReset

boolean getPasswordReset()

isPasswordReset

boolean isPasswordReset()

setPasswordReset

void setPasswordReset(boolean passwordReset)

getPasswordModifiedDate

Date getPasswordModifiedDate()

setPasswordModifiedDate

void setPasswordModifiedDate(Date passwordModifiedDate)

getReminderQueryQuestion

String getReminderQueryQuestion()

setReminderQueryQuestion

void setReminderQueryQuestion(String reminderQueryQuestion)

getReminderQueryAnswer

String getReminderQueryAnswer()

setReminderQueryAnswer

void setReminderQueryAnswer(String reminderQueryAnswer)

getGraceLoginCount

int getGraceLoginCount()

setGraceLoginCount

void setGraceLoginCount(int graceLoginCount)

getScreenName

String getScreenName()

setScreenName

void setScreenName(String screenName)

getEmailAddress

String getEmailAddress()

setEmailAddress

void setEmailAddress(String emailAddress)

getFacebookId

long getFacebookId()

setFacebookId

void setFacebookId(long facebookId)

getOpenId

String getOpenId()

setOpenId

void setOpenId(String openId)

getPortraitId

long getPortraitId()

setPortraitId

void setPortraitId(long portraitId)

getLanguageId

String getLanguageId()

setLanguageId

void setLanguageId(String languageId)

getTimeZoneId

String getTimeZoneId()

setTimeZoneId

void setTimeZoneId(String timeZoneId)

getGreeting

String getGreeting()

setGreeting

void setGreeting(String greeting)

getComments

String getComments()

setComments

void setComments(String comments)

getFirstName

String getFirstName()

setFirstName

void setFirstName(String firstName)

getMiddleName

String getMiddleName()

setMiddleName

void setMiddleName(String middleName)

getLastName

String getLastName()

setLastName

void setLastName(String lastName)

getJobTitle

String getJobTitle()

setJobTitle

void setJobTitle(String jobTitle)

getLoginDate

Date getLoginDate()

setLoginDate

void setLoginDate(Date loginDate)

getLoginIP

String getLoginIP()

setLoginIP

void setLoginIP(String loginIP)

getLastLoginDate

Date getLastLoginDate()

setLastLoginDate

void setLastLoginDate(Date lastLoginDate)

getLastLoginIP

String getLastLoginIP()

setLastLoginIP

void setLastLoginIP(String lastLoginIP)

getLastFailedLoginDate

Date getLastFailedLoginDate()

setLastFailedLoginDate

void setLastFailedLoginDate(Date lastFailedLoginDate)

getFailedLoginAttempts

int getFailedLoginAttempts()

setFailedLoginAttempts

void setFailedLoginAttempts(int failedLoginAttempts)

getLockout

boolean getLockout()

isLockout

boolean isLockout()

setLockout

void setLockout(boolean lockout)

getLockoutDate

Date getLockoutDate()

setLockoutDate

void setLockoutDate(Date lockoutDate)

getAgreedToTermsOfUse

boolean getAgreedToTermsOfUse()

isAgreedToTermsOfUse

boolean isAgreedToTermsOfUse()

setAgreedToTermsOfUse

void setAgreedToTermsOfUse(boolean agreedToTermsOfUse)

getActive

boolean getActive()

isActive

boolean isActive()

setActive

void setActive(boolean active)

toEscapedModel

User toEscapedModel()

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 has been wrapped with an HTML auto escape handler.

Specified by:
isEscapedModel in interface BaseModel<User>
Returns:
true if this model instance has been wrapped with an HTML auto escape handler; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance has been wrapped with an HTML auto escape handler.

A model instance can be wrapped 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 has been wrapped with an HTML auto escape handler
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

Specified by:
getPrimaryKeyObj in interface BaseModel<User>
Returns:
the primary key

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

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 clone

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.3