|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserModel
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.
User
,
UserImpl
,
UserModelImpl
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 |
---|
long getPrimaryKey()
void setPrimaryKey(long pk)
pk
- the primary key of this user@AutoEscape String getUuid()
void setUuid(String uuid)
uuid
- the uuid of this userlong getUserId()
void setUserId(long userId)
userId
- the user id of this userString getUserUuid() throws SystemException
SystemException
- if a system exception occurredvoid setUserUuid(String userUuid)
userUuid
- the user uuid of this userlong getCompanyId()
void setCompanyId(long companyId)
companyId
- the company id of this userDate getCreateDate()
void setCreateDate(Date createDate)
createDate
- the create date of this userDate getModifiedDate()
void setModifiedDate(Date modifiedDate)
modifiedDate
- the modified date of this userboolean getDefaultUser()
boolean isDefaultUser()
void setDefaultUser(boolean defaultUser)
defaultUser
- the default user of this userlong getContactId()
void setContactId(long contactId)
contactId
- the contact id of this user@AutoEscape String getPassword()
void setPassword(String password)
password
- the password of this userboolean getPasswordEncrypted()
boolean isPasswordEncrypted()
void setPasswordEncrypted(boolean passwordEncrypted)
passwordEncrypted
- the password encrypted of this userboolean getPasswordReset()
boolean isPasswordReset()
void setPasswordReset(boolean passwordReset)
passwordReset
- the password reset of this userDate getPasswordModifiedDate()
void setPasswordModifiedDate(Date passwordModifiedDate)
passwordModifiedDate
- the password modified date of this user@AutoEscape String getDigest()
void setDigest(String digest)
digest
- the digest of this user@AutoEscape String getReminderQueryQuestion()
void setReminderQueryQuestion(String reminderQueryQuestion)
reminderQueryQuestion
- the reminder query question of this user@AutoEscape String getReminderQueryAnswer()
void setReminderQueryAnswer(String reminderQueryAnswer)
reminderQueryAnswer
- the reminder query answer of this userint getGraceLoginCount()
void setGraceLoginCount(int graceLoginCount)
graceLoginCount
- the grace login count of this user@AutoEscape String getScreenName()
void setScreenName(String screenName)
screenName
- the screen name of this user@AutoEscape String getEmailAddress()
void setEmailAddress(String emailAddress)
emailAddress
- the email address of this userlong getFacebookId()
void setFacebookId(long facebookId)
facebookId
- the facebook id of this user@AutoEscape String getOpenId()
void setOpenId(String openId)
openId
- the open id of this userlong getPortraitId()
void setPortraitId(long portraitId)
portraitId
- the portrait id of this user@AutoEscape String getLanguageId()
void setLanguageId(String languageId)
languageId
- the language id of this user@AutoEscape String getTimeZoneId()
void setTimeZoneId(String timeZoneId)
timeZoneId
- the time zone id of this user@AutoEscape String getGreeting()
void setGreeting(String greeting)
greeting
- the greeting of this user@AutoEscape String getComments()
void setComments(String comments)
comments
- the comments of this user@AutoEscape String getFirstName()
void setFirstName(String firstName)
firstName
- the first name of this user@AutoEscape String getMiddleName()
void setMiddleName(String middleName)
middleName
- the middle name of this user@AutoEscape String getLastName()
void setLastName(String lastName)
lastName
- the last name of this user@AutoEscape String getJobTitle()
void setJobTitle(String jobTitle)
jobTitle
- the job title of this userDate getLoginDate()
void setLoginDate(Date loginDate)
loginDate
- the login date of this user@AutoEscape String getLoginIP()
void setLoginIP(String loginIP)
loginIP
- the login i p of this userDate getLastLoginDate()
void setLastLoginDate(Date lastLoginDate)
lastLoginDate
- the last login date of this user@AutoEscape String getLastLoginIP()
void setLastLoginIP(String lastLoginIP)
lastLoginIP
- the last login i p of this userDate getLastFailedLoginDate()
void setLastFailedLoginDate(Date lastFailedLoginDate)
lastFailedLoginDate
- the last failed login date of this userint getFailedLoginAttempts()
void setFailedLoginAttempts(int failedLoginAttempts)
failedLoginAttempts
- the failed login attempts of this userboolean getLockout()
boolean isLockout()
void setLockout(boolean lockout)
lockout
- the lockout of this userDate getLockoutDate()
void setLockoutDate(Date lockoutDate)
lockoutDate
- the lockout date of this userboolean getAgreedToTermsOfUse()
boolean isAgreedToTermsOfUse()
void setAgreedToTermsOfUse(boolean agreedToTermsOfUse)
agreedToTermsOfUse
- the agreed to terms of use of this userboolean getActive()
boolean isActive()
void setActive(boolean active)
active
- the active of this userUser toEscapedModel()
AutoEscapeBeanHandler
.
AutoEscapeBeanHandler
boolean isNew()
BaseModel
isNew
in interface BaseModel<User>
true
if this model instance does not yet exist in
the database; false
otherwisevoid setNew(boolean n)
BaseModel
setNew
in interface BaseModel<User>
n
- whether this model instance does not yet exist in the databaseboolean isCachedModel()
BaseModel
isCachedModel
in interface BaseModel<User>
true
if this model instance was retrieved from the
entity cache; false
otherwiseBaseModel.setCachedModel(boolean)
void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel
in interface BaseModel<User>
cachedModel
- whether this model instance was retrieved from the
entity cacheEntityCache
boolean isEscapedModel()
BaseModel
isEscapedModel
in interface BaseModel<User>
true
if this model instance is escaped;
false
otherwiseBaseModel.setEscapedModel(boolean)
void setEscapedModel(boolean escapedModel)
BaseModel
A model instance can be made escaped by wrapping it with an HTML auto
escape handler using its toEscapedModel
method. For example,
toEscapedModel()
.
setEscapedModel
in interface BaseModel<User>
escapedModel
- whether this model instance is escapedAutoEscapeBeanHandler
Serializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj
in interface BaseModel<User>
ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge
in interface BaseModel<User>
void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes
in interface BaseModel<User>
serviceContext
- the service context to retrieve the expando bridge
attributes fromServiceContext.getExpandoBridgeAttributes(
)
Object clone()
BaseModel
clone
in interface BaseModel<User>
int compareTo(User user)
compareTo
in interface Comparable<User>
int hashCode()
hashCode
in class Object
String toString()
toString
in class Object
String toXmlString()
BaseModel
toXmlString
in interface BaseModel<User>
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |