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
modelFields 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.booleanReturns the agreed to terms of use of this user.Returns the user's birth date.Returns the comments of this user.longReturns the company ID of this user.Returns the user's company's mail domain.Returns the user's associated contact.longReturns the contact ID of this user.Returns the create date of this user.longReturns 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.booleanReturns the email address verified of this user.Returns the external reference code of this user.longReturns the facebook ID of this user.intReturns the failed login attempts of this user.booleanReturnstrueif 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.intReturns the grace login count of this user.Returns the greeting of this user.getGroup()longlong[]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.longReturns the ldap server ID of this user.booleanReturns 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.booleangetMale()Returnstrueif the user is male.Returns the middle name of this user.Returns the modified date of this user.longReturns 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.booleanReturns the password encrypted of this user.booleanReturns the password modified date of this user.booleanReturns the password reset of this user.longReturns the portrait ID of this user.getPortraitURL(ThemeDisplay themeDisplay) longReturns the primary key of this user.intintReturns 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) intReturns the status of this user.long[]getTeams()Returns the time zone ID of this user.intgetType()Returns the type of this user.getUnlockDate(PasswordPolicy passwordPolicy) long[]longReturns the user ID of this user.Returns the user uuid of this user.getUuid()Returns the uuid of this user.booleanbooleanhasCompanyMx(String emailAddress) booleanbooleanbooleanbooleanbooleanbooleanisActive()booleanReturnstrueif this user is agreed to terms of use.booleanDeprecated.As of Cavanaugh (7.4.x), replaced byisGuestUser()booleanbooleanbooleanReturnstrueif this user is email address verified.booleanisFemale()booleanbooleanReturnstrueif this user is lockout.booleanisMale()booleanbooleanReturnstrueif this user is password encrypted.booleanbooleanReturnstrueif this user is password reset.booleanbooleanbooleanbooleanbooleanvoidpersist()Updates this model instance in the database or adds it if it does not yet exist.voidsetAgreedToTermsOfUse(boolean agreedToTermsOfUse) Sets whether this user is agreed to terms of use.voidsetComments(String comments) Sets the comments of this user.voidsetCompanyId(long companyId) Sets the company ID of this user.voidsetContact(Contact contact) voidsetContactId(long contactId) Sets the contact ID of this user.voidsetCreateDate(Date createDate) Sets the create date of this user.voidsetCtCollectionId(long ctCollectionId) Sets the ct collection ID of this user.voidSets the digest of this user.voidsetEmailAddress(String emailAddress) Sets the email address of this user.voidsetEmailAddressVerified(boolean emailAddressVerified) Sets whether this user is email address verified.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this user.voidsetFacebookId(long facebookId) Sets the facebook ID of this user.voidsetFailedLoginAttempts(int failedLoginAttempts) Sets the failed login attempts of this user.voidsetFirstName(String firstName) Sets the first name of this user.voidsetGoogleUserId(String googleUserId) Sets the google user ID of this user.voidsetGraceLoginCount(int graceLoginCount) Sets the grace login count of this user.voidsetGreeting(String greeting) Sets the greeting of this user.voidvoidsetGroupId(long groupId) voidsetGroupIds(long[] groupIds) voidsetJobTitle(String jobTitle) Sets the job title of this user.voidsetLanguageId(String languageId) Sets the language ID of this user.voidsetLastFailedLoginDate(Date lastFailedLoginDate) Sets the last failed login date of this user.voidsetLastLoginDate(Date lastLoginDate) Sets the last login date of this user.voidsetLastLoginIP(String lastLoginIP) Sets the last login ip of this user.voidsetLastName(String lastName) Sets the last name of this user.voidsetLdapServerId(long ldapServerId) Sets the ldap server ID of this user.voidsetLockout(boolean lockout) Sets whether this user is lockout.voidsetLockoutDate(Date lockoutDate) Sets the lockout date of this user.voidsetLoginDate(Date loginDate) Sets the login date of this user.voidsetLoginIP(String loginIP) Sets the login ip of this user.voidsetMiddleName(String middleName) Sets the middle name of this user.voidsetModelAttributes(Map<String, Object> attributes) voidsetModifiedDate(Date modifiedDate) Sets the modified date of this user.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this user.voidSets the open ID of this user.voidsetOrganizationIds(long[] organizationIds) voidsetPassword(String password) Sets the password of this user.voidsetPasswordEncrypted(boolean passwordEncrypted) Sets whether this user is password encrypted.voidsetPasswordModified(boolean passwordModified) voidsetPasswordModifiedDate(Date passwordModifiedDate) Sets the password modified date of this user.voidsetPasswordReset(boolean passwordReset) Sets whether this user is password reset.voidsetPasswordUnencrypted(String passwordUnencrypted) voidsetPortraitId(long portraitId) Sets the portrait ID of this user.voidsetPrimaryKey(long primaryKey) Sets the primary key of this user.voidsetReminderQueryAnswer(String reminderQueryAnswer) Sets the reminder query answer of this user.voidsetReminderQueryQuestion(String reminderQueryQuestion) Sets the reminder query question of this user.voidsetRoleIds(long[] roleIds) voidsetScreenName(String screenName) Sets the screen name of this user.voidsetStatus(int status) Sets the status of this user.voidsetTeamIds(long[] teamIds) voidsetTimeZoneId(String timeZoneId) Sets the time zone ID of this user.voidsetType(int type) Sets the type of this user.voidsetUserGroupIds(long[] userGroupIds) voidsetUserId(long userId) Sets the user ID of this user.voidsetUserUuid(String userUuid) Sets the user uuid of this user.voidSets the uuid of this user.protected UserWrapperMethods 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, toUnescapedModelMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods 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, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.ModelWrapper
getWrappedModelMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone
-
Constructor Details
-
UserWrapper
-
-
Method Details
-
getModelAttributes
- Specified by:
getModelAttributesin interfaceBaseModel<User>
-
setModelAttributes
- Specified by:
setModelAttributesin interfaceBaseModel<User>
-
cloneWithOriginalValues
- Specified by:
cloneWithOriginalValuesin interfaceBaseModel<User>- Specified by:
cloneWithOriginalValuesin interfaceUserModel
-
fetchContact
- Specified by:
fetchContactin interfaceUser
-
fetchPortraitURL
- Specified by:
fetchPortraitURLin interfaceUser
-
getAddresses
Returns the user's addresses.- Specified by:
getAddressesin interfaceUser- Returns:
- the user's addresses
-
getAgreedToTermsOfUse
public boolean getAgreedToTermsOfUse()Returns the agreed to terms of use of this user.- Specified by:
getAgreedToTermsOfUsein interfaceUserModel- Returns:
- the agreed to terms of use of this user
-
getAllGroups
- Specified by:
getAllGroupsin interfaceUser- Throws:
PortalException
-
getAllRoles
- Specified by:
getAllRolesin interfaceUser- Throws:
PortalException
-
getBirthday
Returns the user's birth date.- Specified by:
getBirthdayin interfaceUser- Returns:
- the user's birth date
- Throws:
PortalException
-
getComments
Returns the comments of this user.- Specified by:
getCommentsin interfaceUserModel- Returns:
- the comments of this user
-
getCompanyId
public long getCompanyId()Returns the company ID of this user.- Specified by:
getCompanyIdin interfaceShardedModel- Specified by:
getCompanyIdin interfaceStagedModel- Specified by:
getCompanyIdin interfaceUserModel- Returns:
- the company ID of this user
-
getCompanyMx
Returns the user's company's mail domain.- Specified by:
getCompanyMxin interfaceUser- Returns:
- the user's company's mail domain
- Throws:
PortalException
-
getContact
Returns the user's associated contact.- Specified by:
getContactin interfaceUser- Returns:
- the user's associated contact
- Throws:
PortalException- See Also:
-
getContactId
public long getContactId()Returns the contact ID of this user.- Specified by:
getContactIdin interfaceUserModel- Returns:
- the contact ID of this user
-
getCreateDate
Returns the create date of this user.- Specified by:
getCreateDatein interfaceStagedModel- Specified by:
getCreateDatein interfaceUserModel- Returns:
- the create date of this user
-
getCtCollectionId
public long getCtCollectionId()Returns the ct collection ID of this user.- Specified by:
getCtCollectionIdin interfaceCTModel<User>- Specified by:
getCtCollectionIdin 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:
getDisplayEmailAddressin 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:
getDisplayURLin 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
privateLayoutistrue, 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:
getDisplayURLin 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:
PortalExceptionPortalException
-
getEmailAddress
Returns the email address of this user.- Specified by:
getEmailAddressin interfaceUserModel- Returns:
- the email address of this user
-
getEmailAddresses
Returns the user's email addresses.- Specified by:
getEmailAddressesin interfaceUser- Returns:
- the user's email addresses
-
getEmailAddressVerified
public boolean getEmailAddressVerified()Returns the email address verified of this user.- Specified by:
getEmailAddressVerifiedin interfaceUserModel- Returns:
- the email address verified of this user
-
getExternalReferenceCode
Returns the external reference code of this user.- Specified by:
getExternalReferenceCodein interfaceExternalReferenceCodeModel- Specified by:
getExternalReferenceCodein interfaceUserModel- Returns:
- the external reference code of this user
-
getFacebookId
public long getFacebookId()Returns the facebook ID of this user.- Specified by:
getFacebookIdin interfaceUserModel- Returns:
- the facebook ID of this user
-
getFailedLoginAttempts
public int getFailedLoginAttempts()Returns the failed login attempts of this user.- Specified by:
getFailedLoginAttemptsin interfaceUserModel- Returns:
- the failed login attempts of this user
-
getFemale
Returnstrueif the user is female.- Specified by:
getFemalein interfaceUser- Returns:
trueif the user is female;falseotherwise- Throws:
PortalException
-
getFirstName
Returns the first name of this user.- Specified by:
getFirstNamein interfaceUserModel- Returns:
- the first name of this user
-
getFullName
Returns the user's full name.- Specified by:
getFullNamein interfaceUser- Returns:
- the user's full name
-
getFullName
Returns the user's full name.- Specified by:
getFullNamein interfaceUser- Returns:
- the user's full name
-
getGoogleUserId
Returns the google user ID of this user.- Specified by:
getGoogleUserIdin interfaceUserModel- Returns:
- the google user ID of this user
-
getGraceLoginCount
public int getGraceLoginCount()Returns the grace login count of this user.- Specified by:
getGraceLoginCountin interfaceUserModel- Returns:
- the grace login count of this user
-
getGreeting
Returns the greeting of this user.- Specified by:
getGreetingin interfaceUserModel- Returns:
- the greeting of this user
-
getGroup
-
getGroupId
public long getGroupId()- Specified by:
getGroupIdin interfaceUser
-
getGroupIds
public long[] getGroupIds()- Specified by:
getGroupIdsin interfaceUser
-
getGroups
-
getInheritedGroups
- Specified by:
getInheritedGroupsin interfaceUser- Throws:
PortalException
-
getInheritedRoles
- Specified by:
getInheritedRolesin interfaceUser- Throws:
PortalException
-
getInheritedSiteGroups
- Specified by:
getInheritedSiteGroupsin interfaceUser- Throws:
PortalException
-
getInheritedSiteRoles
- Specified by:
getInheritedSiteRolesin interfaceUser
-
getInitials
- Specified by:
getInitialsin interfaceUser
-
getJobTitle
Returns the job title of this user.- Specified by:
getJobTitlein interfaceUserModel- Returns:
- the job title of this user
-
getLanguageId
Returns the language ID of this user.- Specified by:
getLanguageIdin interfaceUserModel- Returns:
- the language ID of this user
-
getLastFailedLoginDate
Returns the last failed login date of this user.- Specified by:
getLastFailedLoginDatein interfaceUserModel- Returns:
- the last failed login date of this user
-
getLastLoginDate
Returns the last login date of this user.- Specified by:
getLastLoginDatein interfaceUserModel- Returns:
- the last login date of this user
-
getLastLoginIP
Returns the last login ip of this user.- Specified by:
getLastLoginIPin interfaceUserModel- Returns:
- the last login ip of this user
-
getLastName
Returns the last name of this user.- Specified by:
getLastNamein interfaceUserModel- Returns:
- the last name of this user
-
getLdapServerId
public long getLdapServerId()Returns the ldap server ID of this user.- Specified by:
getLdapServerIdin interfaceUserModel- Returns:
- the ldap server ID of this user
-
getLocale
-
getLockout
public boolean getLockout()Returns the lockout of this user.- Specified by:
getLockoutin interfaceUserModel- Returns:
- the lockout of this user
-
getLockoutDate
Returns the lockout date of this user.- Specified by:
getLockoutDatein interfaceUserModel- Returns:
- the lockout date of this user
-
getLogin
- Specified by:
getLoginin interfaceUser- Throws:
PortalException
-
getLoginDate
Returns the login date of this user.- Specified by:
getLoginDatein interfaceUserModel- Returns:
- the login date of this user
-
getLoginIP
Returns the login ip of this user.- Specified by:
getLoginIPin interfaceUserModel- Returns:
- the login ip of this user
-
getMale
Returnstrueif the user is male.- Specified by:
getMalein interfaceUser- Returns:
trueif the user is male;falseotherwise- Throws:
PortalException
-
getMiddleName
Returns the middle name of this user.- Specified by:
getMiddleNamein interfaceUserModel- Returns:
- the middle name of this user
-
getModifiedDate
Returns the modified date of this user.- Specified by:
getModifiedDatein interfaceStagedModel- Specified by:
getModifiedDatein interfaceUserModel- Returns:
- the modified date of this user
-
getMvccVersion
public long getMvccVersion()Returns the mvcc version of this user.- Specified by:
getMvccVersionin interfaceMVCCModel- Specified by:
getMvccVersionin interfaceUserModel- Returns:
- the mvcc version of this user
-
getMySiteGroups
- Specified by:
getMySiteGroupsin interfaceUser- Throws:
PortalException
-
getMySiteGroups
- Specified by:
getMySiteGroupsin interfaceUser- Throws:
PortalException
-
getMySiteGroups
- Specified by:
getMySiteGroupsin interfaceUser- Throws:
PortalException
-
getOpenId
Returns the open ID of this user. -
getOrganizationIds
- Specified by:
getOrganizationIdsin interfaceUser- Throws:
PortalException
-
getOrganizationIds
- Specified by:
getOrganizationIdsin interfaceUser- Throws:
PortalException
-
getOrganizations
- Specified by:
getOrganizationsin interfaceUser- Throws:
PortalException
-
getOrganizations
- Specified by:
getOrganizationsin interfaceUser- Throws:
PortalException
-
getOrganizations
public List<Organization> getOrganizations(boolean includeAdministrative, boolean includeParentOrganizations) throws PortalException - Specified by:
getOrganizationsin interfaceUser- Throws:
PortalException
-
getOrganizationsGroups
- Specified by:
getOrganizationsGroupsin interfaceUser- Throws:
PortalException
-
getOrganizationsRoles
- Specified by:
getOrganizationsRolesin interfaceUser- Throws:
PortalException
-
getOriginalEmailAddress
- Specified by:
getOriginalEmailAddressin interfaceUser
-
getPassword
Returns the password of this user.- Specified by:
getPasswordin interfaceUserModel- Returns:
- the password of this user
-
getPasswordEncrypted
public boolean getPasswordEncrypted()Returns the password encrypted of this user.- Specified by:
getPasswordEncryptedin interfaceUserModel- Returns:
- the password encrypted of this user
-
getPasswordModified
public boolean getPasswordModified()- Specified by:
getPasswordModifiedin interfaceUser
-
getPasswordModifiedDate
Returns the password modified date of this user.- Specified by:
getPasswordModifiedDatein interfaceUserModel- Returns:
- the password modified date of this user
-
getPasswordPolicy
- Specified by:
getPasswordPolicyin interfaceUser- Throws:
PortalException
-
getPasswordReset
public boolean getPasswordReset()Returns the password reset of this user.- Specified by:
getPasswordResetin interfaceUserModel- Returns:
- the password reset of this user
-
getPasswordUnencrypted
- Specified by:
getPasswordUnencryptedin interfaceUser
-
getPhones
-
getPortraitId
public long getPortraitId()Returns the portrait ID of this user.- Specified by:
getPortraitIdin interfaceUserModel- Returns:
- the portrait ID of this user
-
getPortraitURL
- Specified by:
getPortraitURLin interfaceUser- Throws:
PortalException
-
getPrimaryKey
public long getPrimaryKey()Returns the primary key of this user.- Specified by:
getPrimaryKeyin interfaceCTModel<User>- Specified by:
getPrimaryKeyin interfaceUserModel- Returns:
- the primary key of this user
-
getPrivateLayoutsPageCount
- Specified by:
getPrivateLayoutsPageCountin interfaceUser- Throws:
PortalException
-
getPublicLayoutsPageCount
- Specified by:
getPublicLayoutsPageCountin interfaceUser- Throws:
PortalException
-
getReminderQueryAnswer
Returns the reminder query answer of this user.- Specified by:
getReminderQueryAnswerin interfaceUserModel- Returns:
- the reminder query answer of this user
-
getReminderQueryQuestion
Returns the reminder query question of this user.- Specified by:
getReminderQueryQuestionin interfaceUserModel- Returns:
- the reminder query question of this user
-
getReminderQueryQuestions
- Specified by:
getReminderQueryQuestionsin interfaceUser- Throws:
PortalException
-
getRoleIds
public long[] getRoleIds()- Specified by:
getRoleIdsin interfaceUser
-
getRoles
-
getScreenName
Returns the screen name of this user.- Specified by:
getScreenNamein interfaceUserModel- Returns:
- the screen name of this user
-
getSiteGroups
- Specified by:
getSiteGroupsin interfaceUser- Throws:
PortalException
-
getSiteGroups
- Specified by:
getSiteGroupsin interfaceUser- Throws:
PortalException
-
getSiteRoles
- Specified by:
getSiteRolesin interfaceUser- Throws:
PortalException
-
getStatus
public int getStatus()Returns the status of this user. -
getTeamIds
public long[] getTeamIds()- Specified by:
getTeamIdsin interfaceUser
-
getTeams
-
getTimeZone
- Specified by:
getTimeZonein interfaceUser
-
getTimeZoneId
Returns the time zone ID of this user.- Specified by:
getTimeZoneIdin interfaceUserModel- Returns:
- the time zone ID of this user
-
getType
public int getType()Returns the type of this user. -
getUnlockDate
- Specified by:
getUnlockDatein interfaceUser- Throws:
PortalException
-
getUnlockDate
- Specified by:
getUnlockDatein interfaceUser
-
getUserGroupIds
public long[] getUserGroupIds()- Specified by:
getUserGroupIdsin interfaceUser
-
getUserGroupRoles
- Specified by:
getUserGroupRolesin interfaceUser- Throws:
PortalException
-
getUserGroups
- Specified by:
getUserGroupsin interfaceUser
-
getUserId
public long getUserId()Returns the user ID of this user. -
getUserUuid
Returns the user uuid of this user.- Specified by:
getUserUuidin interfaceUserModel- Returns:
- the user uuid of this user
-
getUuid
Returns the uuid of this user.- Specified by:
getUuidin interfaceStagedModel- Specified by:
getUuidin interfaceUserModel- Returns:
- the uuid of this user
-
getWebsites
- Specified by:
getWebsitesin interfaceUser
-
hasCompanyMx
- Specified by:
hasCompanyMxin interfaceUser- Throws:
PortalException
-
hasCompanyMx
- Specified by:
hasCompanyMxin interfaceUser- Throws:
PortalException
-
hasMySites
- Specified by:
hasMySitesin interfaceUser- Throws:
PortalException
-
hasOrganization
public boolean hasOrganization()- Specified by:
hasOrganizationin interfaceUser
-
hasPrivateLayouts
- Specified by:
hasPrivateLayoutsin interfaceUser- Throws:
PortalException
-
hasPublicLayouts
- Specified by:
hasPublicLayoutsin interfaceUser- Throws:
PortalException
-
hasReminderQuery
public boolean hasReminderQuery()- Specified by:
hasReminderQueryin interfaceUser
-
isActive
public boolean isActive() -
isAgreedToTermsOfUse
public boolean isAgreedToTermsOfUse()Returnstrueif this user is agreed to terms of use.- Specified by:
isAgreedToTermsOfUsein interfaceUserModel- Returns:
trueif this user is agreed to terms of use;falseotherwise
-
isDefaultUser
Deprecated.As of Cavanaugh (7.4.x), replaced byisGuestUser()- Specified by:
isDefaultUserin interfaceUser
-
isEmailAddressComplete
public boolean isEmailAddressComplete()- Specified by:
isEmailAddressCompletein interfaceUser
-
isEmailAddressVerificationComplete
public boolean isEmailAddressVerificationComplete()- Specified by:
isEmailAddressVerificationCompletein interfaceUser
-
isEmailAddressVerified
public boolean isEmailAddressVerified()Returnstrueif this user is email address verified.- Specified by:
isEmailAddressVerifiedin interfaceUserModel- Returns:
trueif this user is email address verified;falseotherwise
-
isFemale
- Specified by:
isFemalein interfaceUser- Throws:
PortalException
-
isGuestUser
public boolean isGuestUser()- Specified by:
isGuestUserin interfaceUser
-
isLockout
public boolean isLockout()Returnstrueif this user is lockout. -
isMale
- Specified by:
isMalein interfaceUser- Throws:
PortalException
-
isOnDemandUser
public boolean isOnDemandUser()- Specified by:
isOnDemandUserin interfaceUser
-
isPasswordEncrypted
public boolean isPasswordEncrypted()Returnstrueif this user is password encrypted.- Specified by:
isPasswordEncryptedin interfaceUserModel- Returns:
trueif this user is password encrypted;falseotherwise
-
isPasswordModified
public boolean isPasswordModified()- Specified by:
isPasswordModifiedin interfaceUser
-
isPasswordReset
public boolean isPasswordReset()Returnstrueif this user is password reset.- Specified by:
isPasswordResetin interfaceUserModel- Returns:
trueif this user is password reset;falseotherwise
-
isPasswordResetRequired
public boolean isPasswordResetRequired()- Specified by:
isPasswordResetRequiredin interfaceUser
-
isReminderQueryComplete
public boolean isReminderQueryComplete()- Specified by:
isReminderQueryCompletein interfaceUser
-
isServiceAccountUser
public boolean isServiceAccountUser()- Specified by:
isServiceAccountUserin interfaceUser
-
isSetupComplete
public boolean isSetupComplete()- Specified by:
isSetupCompletein interfaceUser
-
isTermsOfUseComplete
public boolean isTermsOfUseComplete()- Specified by:
isTermsOfUseCompletein interfaceUser
-
persist
public void persist()Description copied from interface:PersistedModelUpdates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.- Specified by:
persistin interfacePersistedModel
-
setAgreedToTermsOfUse
public void setAgreedToTermsOfUse(boolean agreedToTermsOfUse) Sets whether this user is agreed to terms of use.- Specified by:
setAgreedToTermsOfUsein interfaceUserModel- Parameters:
agreedToTermsOfUse- the agreed to terms of use of this user
-
setComments
Sets the comments of this user.- Specified by:
setCommentsin interfaceUserModel- Parameters:
comments- the comments of this user
-
setCompanyId
public void setCompanyId(long companyId) Sets the company ID of this user.- Specified by:
setCompanyIdin interfaceShardedModel- Specified by:
setCompanyIdin interfaceStagedModel- Specified by:
setCompanyIdin interfaceUserModel- Parameters:
companyId- the company ID of this user
-
setContact
- Specified by:
setContactin interfaceUser
-
setContactId
public void setContactId(long contactId) Sets the contact ID of this user.- Specified by:
setContactIdin interfaceUserModel- Parameters:
contactId- the contact ID of this user
-
setCreateDate
Sets the create date of this user.- Specified by:
setCreateDatein interfaceStagedModel- Specified by:
setCreateDatein 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:
setCtCollectionIdin interfaceCTModel<User>- Specified by:
setCtCollectionIdin 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:
setEmailAddressin 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:
setEmailAddressVerifiedin interfaceUserModel- Parameters:
emailAddressVerified- the email address verified of this user
-
setExternalReferenceCode
Sets the external reference code of this user.- Specified by:
setExternalReferenceCodein interfaceExternalReferenceCodeModel- Specified by:
setExternalReferenceCodein 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:
setFacebookIdin 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:
setFailedLoginAttemptsin interfaceUserModel- Parameters:
failedLoginAttempts- the failed login attempts of this user
-
setFirstName
Sets the first name of this user.- Specified by:
setFirstNamein interfaceUserModel- Parameters:
firstName- the first name of this user
-
setGoogleUserId
Sets the google user ID of this user.- Specified by:
setGoogleUserIdin 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:
setGraceLoginCountin interfaceUserModel- Parameters:
graceLoginCount- the grace login count of this user
-
setGreeting
Sets the greeting of this user.- Specified by:
setGreetingin interfaceUserModel- Parameters:
greeting- the greeting of this user
-
setGroup
-
setGroupId
public void setGroupId(long groupId) - Specified by:
setGroupIdin interfaceUser
-
setGroupIds
public void setGroupIds(long[] groupIds) - Specified by:
setGroupIdsin interfaceUser
-
setJobTitle
Sets the job title of this user.- Specified by:
setJobTitlein interfaceUserModel- Parameters:
jobTitle- the job title of this user
-
setLanguageId
Sets the language ID of this user.- Specified by:
setLanguageIdin interfaceUserModel- Parameters:
languageId- the language ID of this user
-
setLastFailedLoginDate
Sets the last failed login date of this user.- Specified by:
setLastFailedLoginDatein interfaceUserModel- Parameters:
lastFailedLoginDate- the last failed login date of this user
-
setLastLoginDate
Sets the last login date of this user.- Specified by:
setLastLoginDatein interfaceUserModel- Parameters:
lastLoginDate- the last login date of this user
-
setLastLoginIP
Sets the last login ip of this user.- Specified by:
setLastLoginIPin interfaceUserModel- Parameters:
lastLoginIP- the last login ip of this user
-
setLastName
Sets the last name of this user.- Specified by:
setLastNamein 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:
setLdapServerIdin interfaceUserModel- Parameters:
ldapServerId- the ldap server ID of this user
-
setLockout
public void setLockout(boolean lockout) Sets whether this user is lockout.- Specified by:
setLockoutin interfaceUserModel- Parameters:
lockout- the lockout of this user
-
setLockoutDate
Sets the lockout date of this user.- Specified by:
setLockoutDatein interfaceUserModel- Parameters:
lockoutDate- the lockout date of this user
-
setLoginDate
Sets the login date of this user.- Specified by:
setLoginDatein interfaceUserModel- Parameters:
loginDate- the login date of this user
-
setLoginIP
Sets the login ip of this user.- Specified by:
setLoginIPin interfaceUserModel- Parameters:
loginIP- the login ip of this user
-
setMiddleName
Sets the middle name of this user.- Specified by:
setMiddleNamein interfaceUserModel- Parameters:
middleName- the middle name of this user
-
setModifiedDate
Sets the modified date of this user.- Specified by:
setModifiedDatein interfaceStagedModel- Specified by:
setModifiedDatein interfaceUserModel- Parameters:
modifiedDate- the modified date of this user
-
setMvccVersion
public void setMvccVersion(long mvccVersion) Sets the mvcc version of this user.- Specified by:
setMvccVersionin interfaceMVCCModel- Specified by:
setMvccVersionin 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:
setOrganizationIdsin interfaceUser
-
setPassword
Sets the password of this user.- Specified by:
setPasswordin interfaceUserModel- Parameters:
password- the password of this user
-
setPasswordEncrypted
public void setPasswordEncrypted(boolean passwordEncrypted) Sets whether this user is password encrypted.- Specified by:
setPasswordEncryptedin interfaceUserModel- Parameters:
passwordEncrypted- the password encrypted of this user
-
setPasswordModified
public void setPasswordModified(boolean passwordModified) - Specified by:
setPasswordModifiedin interfaceUser
-
setPasswordModifiedDate
Sets the password modified date of this user.- Specified by:
setPasswordModifiedDatein 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:
setPasswordResetin interfaceUserModel- Parameters:
passwordReset- the password reset of this user
-
setPasswordUnencrypted
- Specified by:
setPasswordUnencryptedin interfaceUser
-
setPortraitId
public void setPortraitId(long portraitId) Sets the portrait ID of this user.- Specified by:
setPortraitIdin interfaceUserModel- Parameters:
portraitId- the portrait ID of this user
-
setPrimaryKey
public void setPrimaryKey(long primaryKey) Sets the primary key of this user.- Specified by:
setPrimaryKeyin interfaceCTModel<User>- Specified by:
setPrimaryKeyin interfaceUserModel- Parameters:
primaryKey- the primary key of this user
-
setReminderQueryAnswer
Sets the reminder query answer of this user.- Specified by:
setReminderQueryAnswerin interfaceUserModel- Parameters:
reminderQueryAnswer- the reminder query answer of this user
-
setReminderQueryQuestion
Sets the reminder query question of this user.- Specified by:
setReminderQueryQuestionin interfaceUserModel- Parameters:
reminderQueryQuestion- the reminder query question of this user
-
setRoleIds
public void setRoleIds(long[] roleIds) - Specified by:
setRoleIdsin interfaceUser
-
setScreenName
Sets the screen name of this user.- Specified by:
setScreenNamein 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:
setTeamIdsin interfaceUser
-
setTimeZoneId
Sets the time zone ID of this user.- Specified by:
setTimeZoneIdin 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:
setUserGroupIdsin interfaceUser
-
setUserId
public void setUserId(long userId) Sets the user ID of this user. -
setUserUuid
Sets the user uuid of this user.- Specified by:
setUserUuidin interfaceUserModel- Parameters:
userUuid- the user uuid of this user
-
setUuid
Sets the uuid of this user.- Specified by:
setUuidin interfaceStagedModel- Specified by:
setUuidin interfaceUserModel- Parameters:
uuid- the uuid of this user
-
toXmlString
- Specified by:
toXmlStringin interfaceUserModel
-
getAttributeGetterFunctions
- Specified by:
getAttributeGetterFunctionsin interfaceBaseModel<User>
-
getAttributeSetterBiConsumers
- Specified by:
getAttributeSetterBiConsumersin interfaceBaseModel<User>
-
getStagedModelType
- Specified by:
getStagedModelTypein interfaceStagedModel
-
wrap
- Specified by:
wrapin classBaseModelWrapper<User>
-