Package com.liferay.portal.kernel.model
Class UserWrapper
Object
com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<User>
com.liferay.portal.kernel.model.UserWrapper
- All Implemented Interfaces:
BaseModel<User>
,CTModel<User>
,ClassedModel
,ExternalReferenceCodeModel
,ModelWrapper<User>
,MVCCModel
,PersistedModel
,ShardedModel
,StagedModel
,User
,UserModel
,Serializable
,Cloneable
,Comparable<User>
This class is a wrapper for User
.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Field Summary
Fields inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper
model
Fields inherited from interface com.liferay.portal.kernel.model.User
USER_ID_ACCESSOR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfetchPortraitURL
(ThemeDisplay themeDisplay) Returns the user's addresses.boolean
Returns the agreed to terms of use of this user.Returns the user's birth date.Returns the comments of this user.long
Returns the company ID of this user.Returns the user's company's mail domain.Returns the user's associated contact.long
Returns the contact ID of this user.Returns the create date of this user.long
Returns the ct collection ID of this user.Returns the digest of this user.Deprecated.As of Cavanaugh (7.4.x), with no direct replacementReturns the user's primary email address, or a blank string if the address is fake.getDisplayURL
(ThemeDisplay themeDisplay) Returns the user's display URL based on the theme display, discounting the URL of the user's default intranet site home page.getDisplayURL
(ThemeDisplay themeDisplay, boolean privateLayout) Returns the user's display URL based on the theme display.Returns the email address of this user.Returns the user's email addresses.boolean
Returns the email address verified of this user.Returns the external reference code of this user.long
Returns the facebook ID of this user.int
Returns the failed login attempts of this user.boolean
Returnstrue
if the user is female.Returns the first name of this user.Returns the user's full name.getFullName
(boolean usePrefix, boolean useSuffix) Returns the user's full name.Returns the google user ID of this user.int
Returns the grace login count of this user.Returns the greeting of this user.getGroup()
long
long[]
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.long
Returns the ldap server ID of this user.boolean
Returns the lockout of this user.Returns the lockout date of this user.getLogin()
Returns the login date of this user.Returns the login ip of this user.boolean
getMale()
Returnstrue
if the user is male.Returns the middle name of this user.Returns the modified date of this user.long
Returns the mvcc version of this user.getMySiteGroups
(int max) getMySiteGroups
(String[] classNames, int max) Returns the open ID of this user.long[]
long[]
getOrganizationIds
(boolean includeAdministrative) getOrganizations
(boolean includeAdministrative) getOrganizations
(boolean includeAdministrative, boolean includeParentOrganizations) Returns the password of this user.boolean
Returns the password encrypted of this user.boolean
Returns the password modified date of this user.boolean
Returns the password reset of this user.long
Returns the portrait ID of this user.getPortraitURL
(ThemeDisplay themeDisplay) long
Returns the primary key of this user.int
int
Returns the reminder query answer of this user.Returns the reminder query question of this user.long[]
getRoles()
Returns the screen name of this user.getSiteGroups
(boolean includeAdministrative) int
Returns the status of this user.long[]
getTeams()
Returns the time zone ID of this user.int
getType()
Returns the type of this user.getUnlockDate
(PasswordPolicy passwordPolicy) long[]
long
Returns the user ID of this user.Returns the user uuid of this user.getUuid()
Returns the uuid of this user.boolean
boolean
hasCompanyMx
(String emailAddress) boolean
boolean
boolean
boolean
boolean
boolean
isActive()
boolean
Returnstrue
if this user is agreed to terms of use.boolean
Deprecated.As of Cavanaugh (7.4.x), replaced byisGuestUser()
boolean
boolean
boolean
Returnstrue
if this user is email address verified.boolean
isFemale()
boolean
boolean
Returnstrue
if this user is lockout.boolean
isMale()
boolean
boolean
Returnstrue
if this user is password encrypted.boolean
boolean
Returnstrue
if this user is password reset.boolean
boolean
boolean
boolean
boolean
void
persist()
Updates this model instance in the database or adds it if it does not yet exist.void
setAgreedToTermsOfUse
(boolean agreedToTermsOfUse) Sets whether this user is agreed to terms of use.void
setComments
(String comments) Sets the comments of this user.void
setCompanyId
(long companyId) Sets the company ID of this user.void
setContact
(Contact contact) void
setContactId
(long contactId) Sets the contact ID of this user.void
setCreateDate
(Date createDate) Sets the create date of this user.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this user.void
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
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this user.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
setGoogleUserId
(String googleUserId) Sets the google user ID 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
void
setGroupId
(long groupId) void
setGroupIds
(long[] groupIds) 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 ip of this user.void
setLastName
(String lastName) Sets the last name of this user.void
setLdapServerId
(long ldapServerId) Sets the ldap server ID 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 ip of this user.void
setMiddleName
(String middleName) Sets the middle name of this user.void
setModelAttributes
(Map<String, Object> attributes) void
setModifiedDate
(Date modifiedDate) Sets the modified date of this user.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this user.void
Sets the open ID of this user.void
setOrganizationIds
(long[] organizationIds) void
setPassword
(String password) Sets the password of this user.void
setPasswordEncrypted
(boolean passwordEncrypted) Sets whether this user is password encrypted.void
setPasswordModified
(boolean passwordModified) void
setPasswordModifiedDate
(Date passwordModifiedDate) Sets the password modified date of this user.void
setPasswordReset
(boolean passwordReset) Sets whether this user is password reset.void
setPasswordUnencrypted
(String passwordUnencrypted) void
setPortraitId
(long portraitId) Sets the portrait ID of this user.void
setPrimaryKey
(long primaryKey) 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
setRoleIds
(long[] roleIds) void
setScreenName
(String screenName) Sets the screen name of this user.void
setStatus
(int status) Sets the status of this user.void
setTeamIds
(long[] teamIds) void
setTimeZoneId
(String timeZoneId) Sets the time zone ID of this user.void
setType
(int type) Sets the type of this user.void
setUserGroupIds
(long[] userGroupIds) void
setUserId
(long userId) Sets the user ID of this user.void
setUserUuid
(String userUuid) Sets the user uuid of this user.void
Sets the uuid of this user.protected UserWrapper
Methods inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper
clone, compareTo, equals, getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, getWrappedModel, hashCode, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModel
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getExpandoBridge, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.ModelWrapper
getWrappedModel
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone
-
Constructor Details
-
UserWrapper
-
-
Method Details
-
getModelAttributes
- Specified by:
getModelAttributes
in interfaceBaseModel<User>
-
setModelAttributes
- Specified by:
setModelAttributes
in interfaceBaseModel<User>
-
cloneWithOriginalValues
- Specified by:
cloneWithOriginalValues
in interfaceBaseModel<User>
- Specified by:
cloneWithOriginalValues
in interfaceUserModel
-
fetchContact
- Specified by:
fetchContact
in interfaceUser
-
fetchPortraitURL
- Specified by:
fetchPortraitURL
in interfaceUser
-
getAddresses
Returns the user's addresses.- Specified by:
getAddresses
in interfaceUser
- Returns:
- the user's addresses
-
getAgreedToTermsOfUse
public boolean getAgreedToTermsOfUse()Returns the agreed to terms of use of this user.- Specified by:
getAgreedToTermsOfUse
in interfaceUserModel
- Returns:
- the agreed to terms of use of this user
-
getAllGroups
- Specified by:
getAllGroups
in interfaceUser
- Throws:
PortalException
-
getAllRoles
- Specified by:
getAllRoles
in interfaceUser
- Throws:
PortalException
-
getBirthday
Returns the user's birth date.- Specified by:
getBirthday
in interfaceUser
- Returns:
- the user's birth date
- Throws:
PortalException
-
getComments
Returns the comments of this user.- Specified by:
getComments
in interfaceUserModel
- Returns:
- the comments of this user
-
getCompanyId
public long getCompanyId()Returns the company ID of this user.- Specified by:
getCompanyId
in interfaceShardedModel
- Specified by:
getCompanyId
in interfaceStagedModel
- Specified by:
getCompanyId
in interfaceUserModel
- Returns:
- the company ID of this user
-
getCompanyMx
Returns the user's company's mail domain.- Specified by:
getCompanyMx
in interfaceUser
- Returns:
- the user's company's mail domain
- Throws:
PortalException
-
getContact
Returns the user's associated contact.- Specified by:
getContact
in interfaceUser
- Returns:
- the user's associated contact
- Throws:
PortalException
- See Also:
-
getContactId
public long getContactId()Returns the contact ID of this user.- Specified by:
getContactId
in interfaceUserModel
- Returns:
- the contact ID of this user
-
getCreateDate
Returns the create date of this user.- Specified by:
getCreateDate
in interfaceStagedModel
- Specified by:
getCreateDate
in interfaceUserModel
- Returns:
- the create date of this user
-
getCtCollectionId
public long getCtCollectionId()Returns the ct collection ID of this user.- Specified by:
getCtCollectionId
in interfaceCTModel<User>
- Specified by:
getCtCollectionId
in interfaceUserModel
- Returns:
- the ct collection ID of this user
-
getDigest
Returns the digest of this user. -
getDigest
Deprecated.As of Cavanaugh (7.4.x), with no direct replacementReturns a digest for the user, incorporating the password. -
getDisplayEmailAddress
Returns the user's primary email address, or a blank string if the address is fake.- Specified by:
getDisplayEmailAddress
in interfaceUser
- Returns:
- the user's primary email address, or a blank string if the address is fake
-
getDisplayURL
Returns the user's display URL based on the theme display, discounting the URL of the user's default intranet site home page.The logic for the display URL to return is as follows:
- If the user is the guest user, return an empty string.
- Else, if a friendly URL is available for the user's profile, return that friendly URL.
- Otherwise, return the URL of the user's default extranet site home page.
- Specified by:
getDisplayURL
in interfaceUser
- Parameters:
themeDisplay
- the theme display- Returns:
- the user's display URL
- Throws:
PortalException
-
getDisplayURL
public String getDisplayURL(ThemeDisplay themeDisplay, boolean privateLayout) throws PortalException Returns the user's display URL based on the theme display.The logic for the display URL to return is as follows:
- If the user is the guest user, return an empty string.
- Else, if a friendly URL is available for the user's profile, return that friendly URL.
-
Else, if
privateLayout
istrue
, return the URL of the user's default intranet site home page. - Otherwise, return the URL of the user's default extranet site home page.
- Specified by:
getDisplayURL
in interfaceUser
- Parameters:
themeDisplay
- the theme displayprivateLayout
- whether to use the URL of the user's default intranet (versus extranet) site home page, if no friendly URL is available for the user's profile- Returns:
- the user's display URL
- Throws:
PortalException
PortalException
-
getEmailAddress
Returns the email address of this user.- Specified by:
getEmailAddress
in interfaceUserModel
- Returns:
- the email address of this user
-
getEmailAddresses
Returns the user's email addresses.- Specified by:
getEmailAddresses
in interfaceUser
- Returns:
- the user's email addresses
-
getEmailAddressVerified
public boolean getEmailAddressVerified()Returns the email address verified of this user.- Specified by:
getEmailAddressVerified
in interfaceUserModel
- Returns:
- the email address verified of this user
-
getExternalReferenceCode
Returns the external reference code of this user.- Specified by:
getExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Specified by:
getExternalReferenceCode
in interfaceUserModel
- Returns:
- the external reference code of this user
-
getFacebookId
public long getFacebookId()Returns the facebook ID of this user.- Specified by:
getFacebookId
in interfaceUserModel
- Returns:
- the facebook ID of this user
-
getFailedLoginAttempts
public int getFailedLoginAttempts()Returns the failed login attempts of this user.- Specified by:
getFailedLoginAttempts
in interfaceUserModel
- Returns:
- the failed login attempts of this user
-
getFemale
Returnstrue
if the user is female.- Specified by:
getFemale
in interfaceUser
- Returns:
true
if the user is female;false
otherwise- Throws:
PortalException
-
getFirstName
Returns the first name of this user.- Specified by:
getFirstName
in interfaceUserModel
- Returns:
- the first name of this user
-
getFullName
Returns the user's full name.- Specified by:
getFullName
in interfaceUser
- Returns:
- the user's full name
-
getFullName
Returns the user's full name.- Specified by:
getFullName
in interfaceUser
- Returns:
- the user's full name
-
getGoogleUserId
Returns the google user ID of this user.- Specified by:
getGoogleUserId
in interfaceUserModel
- Returns:
- the google user ID of this user
-
getGraceLoginCount
public int getGraceLoginCount()Returns the grace login count of this user.- Specified by:
getGraceLoginCount
in interfaceUserModel
- Returns:
- the grace login count of this user
-
getGreeting
Returns the greeting of this user.- Specified by:
getGreeting
in interfaceUserModel
- Returns:
- the greeting of this user
-
getGroup
-
getGroupId
public long getGroupId()- Specified by:
getGroupId
in interfaceUser
-
getGroupIds
public long[] getGroupIds()- Specified by:
getGroupIds
in interfaceUser
-
getGroups
-
getInheritedGroups
- Specified by:
getInheritedGroups
in interfaceUser
- Throws:
PortalException
-
getInheritedRoles
- Specified by:
getInheritedRoles
in interfaceUser
- Throws:
PortalException
-
getInheritedSiteGroups
- Specified by:
getInheritedSiteGroups
in interfaceUser
- Throws:
PortalException
-
getInheritedSiteRoles
- Specified by:
getInheritedSiteRoles
in interfaceUser
-
getInitials
- Specified by:
getInitials
in interfaceUser
-
getJobTitle
Returns the job title of this user.- Specified by:
getJobTitle
in interfaceUserModel
- Returns:
- the job title of this user
-
getLanguageId
Returns the language ID of this user.- Specified by:
getLanguageId
in interfaceUserModel
- Returns:
- the language ID of this user
-
getLastFailedLoginDate
Returns the last failed login date of this user.- Specified by:
getLastFailedLoginDate
in interfaceUserModel
- Returns:
- the last failed login date of this user
-
getLastLoginDate
Returns the last login date of this user.- Specified by:
getLastLoginDate
in interfaceUserModel
- Returns:
- the last login date of this user
-
getLastLoginIP
Returns the last login ip of this user.- Specified by:
getLastLoginIP
in interfaceUserModel
- Returns:
- the last login ip of this user
-
getLastName
Returns the last name of this user.- Specified by:
getLastName
in interfaceUserModel
- Returns:
- the last name of this user
-
getLdapServerId
public long getLdapServerId()Returns the ldap server ID of this user.- Specified by:
getLdapServerId
in interfaceUserModel
- Returns:
- the ldap server ID of this user
-
getLocale
-
getLockout
public boolean getLockout()Returns the lockout of this user.- Specified by:
getLockout
in interfaceUserModel
- Returns:
- the lockout of this user
-
getLockoutDate
Returns the lockout date of this user.- Specified by:
getLockoutDate
in interfaceUserModel
- Returns:
- the lockout date of this user
-
getLogin
- Specified by:
getLogin
in interfaceUser
- Throws:
PortalException
-
getLoginDate
Returns the login date of this user.- Specified by:
getLoginDate
in interfaceUserModel
- Returns:
- the login date of this user
-
getLoginIP
Returns the login ip of this user.- Specified by:
getLoginIP
in interfaceUserModel
- Returns:
- the login ip of this user
-
getMale
Returnstrue
if the user is male.- Specified by:
getMale
in interfaceUser
- Returns:
true
if the user is male;false
otherwise- Throws:
PortalException
-
getMiddleName
Returns the middle name of this user.- Specified by:
getMiddleName
in interfaceUserModel
- Returns:
- the middle name of this user
-
getModifiedDate
Returns the modified date of this user.- Specified by:
getModifiedDate
in interfaceStagedModel
- Specified by:
getModifiedDate
in interfaceUserModel
- Returns:
- the modified date of this user
-
getMvccVersion
public long getMvccVersion()Returns the mvcc version of this user.- Specified by:
getMvccVersion
in interfaceMVCCModel
- Specified by:
getMvccVersion
in interfaceUserModel
- Returns:
- the mvcc version of this user
-
getMySiteGroups
- Specified by:
getMySiteGroups
in interfaceUser
- Throws:
PortalException
-
getMySiteGroups
- Specified by:
getMySiteGroups
in interfaceUser
- Throws:
PortalException
-
getMySiteGroups
- Specified by:
getMySiteGroups
in interfaceUser
- Throws:
PortalException
-
getOpenId
Returns the open ID of this user. -
getOrganizationIds
- Specified by:
getOrganizationIds
in interfaceUser
- Throws:
PortalException
-
getOrganizationIds
- Specified by:
getOrganizationIds
in interfaceUser
- Throws:
PortalException
-
getOrganizations
- Specified by:
getOrganizations
in interfaceUser
- Throws:
PortalException
-
getOrganizations
- Specified by:
getOrganizations
in interfaceUser
- Throws:
PortalException
-
getOrganizations
public List<Organization> getOrganizations(boolean includeAdministrative, boolean includeParentOrganizations) throws PortalException - Specified by:
getOrganizations
in interfaceUser
- Throws:
PortalException
-
getOrganizationsGroups
- Specified by:
getOrganizationsGroups
in interfaceUser
- Throws:
PortalException
-
getOrganizationsRoles
- Specified by:
getOrganizationsRoles
in interfaceUser
- Throws:
PortalException
-
getOriginalEmailAddress
- Specified by:
getOriginalEmailAddress
in interfaceUser
-
getPassword
Returns the password of this user.- Specified by:
getPassword
in interfaceUserModel
- Returns:
- the password of this user
-
getPasswordEncrypted
public boolean getPasswordEncrypted()Returns the password encrypted of this user.- Specified by:
getPasswordEncrypted
in interfaceUserModel
- Returns:
- the password encrypted of this user
-
getPasswordModified
public boolean getPasswordModified()- Specified by:
getPasswordModified
in interfaceUser
-
getPasswordModifiedDate
Returns the password modified date of this user.- Specified by:
getPasswordModifiedDate
in interfaceUserModel
- Returns:
- the password modified date of this user
-
getPasswordPolicy
- Specified by:
getPasswordPolicy
in interfaceUser
- Throws:
PortalException
-
getPasswordReset
public boolean getPasswordReset()Returns the password reset of this user.- Specified by:
getPasswordReset
in interfaceUserModel
- Returns:
- the password reset of this user
-
getPasswordUnencrypted
- Specified by:
getPasswordUnencrypted
in interfaceUser
-
getPhones
-
getPortraitId
public long getPortraitId()Returns the portrait ID of this user.- Specified by:
getPortraitId
in interfaceUserModel
- Returns:
- the portrait ID of this user
-
getPortraitURL
- Specified by:
getPortraitURL
in interfaceUser
- Throws:
PortalException
-
getPrimaryKey
public long getPrimaryKey()Returns the primary key of this user.- Specified by:
getPrimaryKey
in interfaceCTModel<User>
- Specified by:
getPrimaryKey
in interfaceUserModel
- Returns:
- the primary key of this user
-
getPrivateLayoutsPageCount
- Specified by:
getPrivateLayoutsPageCount
in interfaceUser
- Throws:
PortalException
-
getPublicLayoutsPageCount
- Specified by:
getPublicLayoutsPageCount
in interfaceUser
- Throws:
PortalException
-
getReminderQueryAnswer
Returns the reminder query answer of this user.- Specified by:
getReminderQueryAnswer
in interfaceUserModel
- Returns:
- the reminder query answer of this user
-
getReminderQueryQuestion
Returns the reminder query question of this user.- Specified by:
getReminderQueryQuestion
in interfaceUserModel
- Returns:
- the reminder query question of this user
-
getReminderQueryQuestions
- Specified by:
getReminderQueryQuestions
in interfaceUser
- Throws:
PortalException
-
getRoleIds
public long[] getRoleIds()- Specified by:
getRoleIds
in interfaceUser
-
getRoles
-
getScreenName
Returns the screen name of this user.- Specified by:
getScreenName
in interfaceUserModel
- Returns:
- the screen name of this user
-
getSiteGroups
- Specified by:
getSiteGroups
in interfaceUser
- Throws:
PortalException
-
getSiteGroups
- Specified by:
getSiteGroups
in interfaceUser
- Throws:
PortalException
-
getSiteRoles
- Specified by:
getSiteRoles
in interfaceUser
- Throws:
PortalException
-
getStatus
public int getStatus()Returns the status of this user. -
getTeamIds
public long[] getTeamIds()- Specified by:
getTeamIds
in interfaceUser
-
getTeams
-
getTimeZone
- Specified by:
getTimeZone
in interfaceUser
-
getTimeZoneId
Returns the time zone ID of this user.- Specified by:
getTimeZoneId
in interfaceUserModel
- Returns:
- the time zone ID of this user
-
getType
public int getType()Returns the type of this user. -
getUnlockDate
- Specified by:
getUnlockDate
in interfaceUser
- Throws:
PortalException
-
getUnlockDate
- Specified by:
getUnlockDate
in interfaceUser
-
getUserGroupIds
public long[] getUserGroupIds()- Specified by:
getUserGroupIds
in interfaceUser
-
getUserGroupRoles
- Specified by:
getUserGroupRoles
in interfaceUser
- Throws:
PortalException
-
getUserGroups
- Specified by:
getUserGroups
in interfaceUser
-
getUserId
public long getUserId()Returns the user ID of this user. -
getUserUuid
Returns the user uuid of this user.- Specified by:
getUserUuid
in interfaceUserModel
- Returns:
- the user uuid of this user
-
getUuid
Returns the uuid of this user.- Specified by:
getUuid
in interfaceStagedModel
- Specified by:
getUuid
in interfaceUserModel
- Returns:
- the uuid of this user
-
getWebsites
- Specified by:
getWebsites
in interfaceUser
-
hasCompanyMx
- Specified by:
hasCompanyMx
in interfaceUser
- Throws:
PortalException
-
hasCompanyMx
- Specified by:
hasCompanyMx
in interfaceUser
- Throws:
PortalException
-
hasMySites
- Specified by:
hasMySites
in interfaceUser
- Throws:
PortalException
-
hasOrganization
public boolean hasOrganization()- Specified by:
hasOrganization
in interfaceUser
-
hasPrivateLayouts
- Specified by:
hasPrivateLayouts
in interfaceUser
- Throws:
PortalException
-
hasPublicLayouts
- Specified by:
hasPublicLayouts
in interfaceUser
- Throws:
PortalException
-
hasReminderQuery
public boolean hasReminderQuery()- Specified by:
hasReminderQuery
in interfaceUser
-
isActive
public boolean isActive() -
isAgreedToTermsOfUse
public boolean isAgreedToTermsOfUse()Returnstrue
if this user is agreed to terms of use.- Specified by:
isAgreedToTermsOfUse
in interfaceUserModel
- Returns:
true
if this user is agreed to terms of use;false
otherwise
-
isDefaultUser
Deprecated.As of Cavanaugh (7.4.x), replaced byisGuestUser()
- Specified by:
isDefaultUser
in interfaceUser
-
isEmailAddressComplete
public boolean isEmailAddressComplete()- Specified by:
isEmailAddressComplete
in interfaceUser
-
isEmailAddressVerificationComplete
public boolean isEmailAddressVerificationComplete()- Specified by:
isEmailAddressVerificationComplete
in interfaceUser
-
isEmailAddressVerified
public boolean isEmailAddressVerified()Returnstrue
if this user is email address verified.- Specified by:
isEmailAddressVerified
in interfaceUserModel
- Returns:
true
if this user is email address verified;false
otherwise
-
isFemale
- Specified by:
isFemale
in interfaceUser
- Throws:
PortalException
-
isGuestUser
public boolean isGuestUser()- Specified by:
isGuestUser
in interfaceUser
-
isLockout
public boolean isLockout()Returnstrue
if this user is lockout. -
isMale
- Specified by:
isMale
in interfaceUser
- Throws:
PortalException
-
isOnDemandUser
public boolean isOnDemandUser()- Specified by:
isOnDemandUser
in interfaceUser
-
isPasswordEncrypted
public boolean isPasswordEncrypted()Returnstrue
if this user is password encrypted.- Specified by:
isPasswordEncrypted
in interfaceUserModel
- Returns:
true
if this user is password encrypted;false
otherwise
-
isPasswordModified
public boolean isPasswordModified()- Specified by:
isPasswordModified
in interfaceUser
-
isPasswordReset
public boolean isPasswordReset()Returnstrue
if this user is password reset.- Specified by:
isPasswordReset
in interfaceUserModel
- Returns:
true
if this user is password reset;false
otherwise
-
isPasswordResetRequired
public boolean isPasswordResetRequired()- Specified by:
isPasswordResetRequired
in interfaceUser
-
isReminderQueryComplete
public boolean isReminderQueryComplete()- Specified by:
isReminderQueryComplete
in interfaceUser
-
isServiceAccountUser
public boolean isServiceAccountUser()- Specified by:
isServiceAccountUser
in interfaceUser
-
isSetupComplete
public boolean isSetupComplete()- Specified by:
isSetupComplete
in interfaceUser
-
isTermsOfUseComplete
public boolean isTermsOfUseComplete()- Specified by:
isTermsOfUseComplete
in interfaceUser
-
persist
public void persist()Description copied from interface:PersistedModel
Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.- Specified by:
persist
in interfacePersistedModel
-
setAgreedToTermsOfUse
public void setAgreedToTermsOfUse(boolean agreedToTermsOfUse) Sets whether this user is agreed to terms of use.- Specified by:
setAgreedToTermsOfUse
in interfaceUserModel
- Parameters:
agreedToTermsOfUse
- the agreed to terms of use of this user
-
setComments
Sets the comments of this user.- Specified by:
setComments
in interfaceUserModel
- Parameters:
comments
- the comments of this user
-
setCompanyId
public void setCompanyId(long companyId) Sets the company ID of this user.- Specified by:
setCompanyId
in interfaceShardedModel
- Specified by:
setCompanyId
in interfaceStagedModel
- Specified by:
setCompanyId
in interfaceUserModel
- Parameters:
companyId
- the company ID of this user
-
setContact
- Specified by:
setContact
in interfaceUser
-
setContactId
public void setContactId(long contactId) Sets the contact ID of this user.- Specified by:
setContactId
in interfaceUserModel
- Parameters:
contactId
- the contact ID of this user
-
setCreateDate
Sets the create date of this user.- Specified by:
setCreateDate
in interfaceStagedModel
- Specified by:
setCreateDate
in interfaceUserModel
- Parameters:
createDate
- the create date of this user
-
setCtCollectionId
public void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this user.- Specified by:
setCtCollectionId
in interfaceCTModel<User>
- Specified by:
setCtCollectionId
in interfaceUserModel
- Parameters:
ctCollectionId
- the ct collection ID of this user
-
setDigest
Sets the digest of this user. -
setEmailAddress
Sets the email address of this user.- Specified by:
setEmailAddress
in interfaceUserModel
- Parameters:
emailAddress
- the email address of this user
-
setEmailAddressVerified
public void setEmailAddressVerified(boolean emailAddressVerified) Sets whether this user is email address verified.- Specified by:
setEmailAddressVerified
in interfaceUserModel
- Parameters:
emailAddressVerified
- the email address verified of this user
-
setExternalReferenceCode
Sets the external reference code of this user.- Specified by:
setExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Specified by:
setExternalReferenceCode
in interfaceUserModel
- Parameters:
externalReferenceCode
- the external reference code of this user
-
setFacebookId
public void setFacebookId(long facebookId) Sets the facebook ID of this user.- Specified by:
setFacebookId
in interfaceUserModel
- Parameters:
facebookId
- the facebook ID of this user
-
setFailedLoginAttempts
public void setFailedLoginAttempts(int failedLoginAttempts) Sets the failed login attempts of this user.- Specified by:
setFailedLoginAttempts
in interfaceUserModel
- Parameters:
failedLoginAttempts
- the failed login attempts of this user
-
setFirstName
Sets the first name of this user.- Specified by:
setFirstName
in interfaceUserModel
- Parameters:
firstName
- the first name of this user
-
setGoogleUserId
Sets the google user ID of this user.- Specified by:
setGoogleUserId
in interfaceUserModel
- Parameters:
googleUserId
- the google user ID of this user
-
setGraceLoginCount
public void setGraceLoginCount(int graceLoginCount) Sets the grace login count of this user.- Specified by:
setGraceLoginCount
in interfaceUserModel
- Parameters:
graceLoginCount
- the grace login count of this user
-
setGreeting
Sets the greeting of this user.- Specified by:
setGreeting
in interfaceUserModel
- Parameters:
greeting
- the greeting of this user
-
setGroup
-
setGroupId
public void setGroupId(long groupId) - Specified by:
setGroupId
in interfaceUser
-
setGroupIds
public void setGroupIds(long[] groupIds) - Specified by:
setGroupIds
in interfaceUser
-
setJobTitle
Sets the job title of this user.- Specified by:
setJobTitle
in interfaceUserModel
- Parameters:
jobTitle
- the job title of this user
-
setLanguageId
Sets the language ID of this user.- Specified by:
setLanguageId
in interfaceUserModel
- Parameters:
languageId
- the language ID of this user
-
setLastFailedLoginDate
Sets the last failed login date of this user.- Specified by:
setLastFailedLoginDate
in interfaceUserModel
- Parameters:
lastFailedLoginDate
- the last failed login date of this user
-
setLastLoginDate
Sets the last login date of this user.- Specified by:
setLastLoginDate
in interfaceUserModel
- Parameters:
lastLoginDate
- the last login date of this user
-
setLastLoginIP
Sets the last login ip of this user.- Specified by:
setLastLoginIP
in interfaceUserModel
- Parameters:
lastLoginIP
- the last login ip of this user
-
setLastName
Sets the last name of this user.- Specified by:
setLastName
in interfaceUserModel
- Parameters:
lastName
- the last name of this user
-
setLdapServerId
public void setLdapServerId(long ldapServerId) Sets the ldap server ID of this user.- Specified by:
setLdapServerId
in interfaceUserModel
- Parameters:
ldapServerId
- the ldap server ID of this user
-
setLockout
public void setLockout(boolean lockout) Sets whether this user is lockout.- Specified by:
setLockout
in interfaceUserModel
- Parameters:
lockout
- the lockout of this user
-
setLockoutDate
Sets the lockout date of this user.- Specified by:
setLockoutDate
in interfaceUserModel
- Parameters:
lockoutDate
- the lockout date of this user
-
setLoginDate
Sets the login date of this user.- Specified by:
setLoginDate
in interfaceUserModel
- Parameters:
loginDate
- the login date of this user
-
setLoginIP
Sets the login ip of this user.- Specified by:
setLoginIP
in interfaceUserModel
- Parameters:
loginIP
- the login ip of this user
-
setMiddleName
Sets the middle name of this user.- Specified by:
setMiddleName
in interfaceUserModel
- Parameters:
middleName
- the middle name of this user
-
setModifiedDate
Sets the modified date of this user.- Specified by:
setModifiedDate
in interfaceStagedModel
- Specified by:
setModifiedDate
in interfaceUserModel
- Parameters:
modifiedDate
- the modified date of this user
-
setMvccVersion
public void setMvccVersion(long mvccVersion) Sets the mvcc version of this user.- Specified by:
setMvccVersion
in interfaceMVCCModel
- Specified by:
setMvccVersion
in interfaceUserModel
- Parameters:
mvccVersion
- the mvcc version of this user
-
setOpenId
Sets the open ID of this user. -
setOrganizationIds
public void setOrganizationIds(long[] organizationIds) - Specified by:
setOrganizationIds
in interfaceUser
-
setPassword
Sets the password of this user.- Specified by:
setPassword
in interfaceUserModel
- Parameters:
password
- the password of this user
-
setPasswordEncrypted
public void setPasswordEncrypted(boolean passwordEncrypted) Sets whether this user is password encrypted.- Specified by:
setPasswordEncrypted
in interfaceUserModel
- Parameters:
passwordEncrypted
- the password encrypted of this user
-
setPasswordModified
public void setPasswordModified(boolean passwordModified) - Specified by:
setPasswordModified
in interfaceUser
-
setPasswordModifiedDate
Sets the password modified date of this user.- Specified by:
setPasswordModifiedDate
in interfaceUserModel
- Parameters:
passwordModifiedDate
- the password modified date of this user
-
setPasswordReset
public void setPasswordReset(boolean passwordReset) Sets whether this user is password reset.- Specified by:
setPasswordReset
in interfaceUserModel
- Parameters:
passwordReset
- the password reset of this user
-
setPasswordUnencrypted
- Specified by:
setPasswordUnencrypted
in interfaceUser
-
setPortraitId
public void setPortraitId(long portraitId) Sets the portrait ID of this user.- Specified by:
setPortraitId
in interfaceUserModel
- Parameters:
portraitId
- the portrait ID of this user
-
setPrimaryKey
public void setPrimaryKey(long primaryKey) Sets the primary key of this user.- Specified by:
setPrimaryKey
in interfaceCTModel<User>
- Specified by:
setPrimaryKey
in interfaceUserModel
- Parameters:
primaryKey
- the primary key of this user
-
setReminderQueryAnswer
Sets the reminder query answer of this user.- Specified by:
setReminderQueryAnswer
in interfaceUserModel
- Parameters:
reminderQueryAnswer
- the reminder query answer of this user
-
setReminderQueryQuestion
Sets the reminder query question of this user.- Specified by:
setReminderQueryQuestion
in interfaceUserModel
- Parameters:
reminderQueryQuestion
- the reminder query question of this user
-
setRoleIds
public void setRoleIds(long[] roleIds) - Specified by:
setRoleIds
in interfaceUser
-
setScreenName
Sets the screen name of this user.- Specified by:
setScreenName
in interfaceUserModel
- Parameters:
screenName
- the screen name of this user
-
setStatus
public void setStatus(int status) Sets the status of this user. -
setTeamIds
public void setTeamIds(long[] teamIds) - Specified by:
setTeamIds
in interfaceUser
-
setTimeZoneId
Sets the time zone ID of this user.- Specified by:
setTimeZoneId
in interfaceUserModel
- Parameters:
timeZoneId
- the time zone ID of this user
-
setType
public void setType(int type) Sets the type of this user. -
setUserGroupIds
public void setUserGroupIds(long[] userGroupIds) - Specified by:
setUserGroupIds
in interfaceUser
-
setUserId
public void setUserId(long userId) Sets the user ID of this user. -
setUserUuid
Sets the user uuid of this user.- Specified by:
setUserUuid
in interfaceUserModel
- Parameters:
userUuid
- the user uuid of this user
-
setUuid
Sets the uuid of this user.- Specified by:
setUuid
in interfaceStagedModel
- Specified by:
setUuid
in interfaceUserModel
- Parameters:
uuid
- the uuid of this user
-
toXmlString
- Specified by:
toXmlString
in interfaceUserModel
-
getAttributeGetterFunctions
- Specified by:
getAttributeGetterFunctions
in interfaceBaseModel<User>
-
getAttributeSetterBiConsumers
- Specified by:
getAttributeSetterBiConsumers
in interfaceBaseModel<User>
-
getStagedModelType
- Specified by:
getStagedModelType
in interfaceStagedModel
-
wrap
- Specified by:
wrap
in classBaseModelWrapper<User>
-