Package com.liferay.portal.kernel.model
Interface User
- All Superinterfaces:
BaseModel<User>
,ClassedModel
,Cloneable
,Comparable<User>
,CTModel<User>
,ExternalReferenceCodeModel
,MVCCModel
,PersistedModel
,Serializable
,ShardedModel
,StagedModel
,UserModel
- All Known Implementing Classes:
UserWrapper
The extended model interface for the User service. Represents a row in the "User_" database table, with each column mapped to a property of this class.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionfetchPortraitURL
(ThemeDisplay themeDisplay) Returns the user's addresses.Returns the user's birth date.Returns the user's company's mail domain.Returns the user's associated contact.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 user's email addresses.boolean
Returnstrue
if the user is female.Returns the user's full name.getFullName
(boolean usePrefix, boolean useSuffix) Returns the user's full name.getGroup()
long
long[]
getLogin()
boolean
getMale()
Returnstrue
if the user is male.getMySiteGroups
(int max) getMySiteGroups
(String[] classNames, int max) long[]
long[]
getOrganizationIds
(boolean includeAdministrative) getOrganizations
(boolean includeAdministrative) getOrganizations
(boolean includeAdministrative, boolean includeParentOrganizations) boolean
getPortraitURL
(ThemeDisplay themeDisplay) int
int
long[]
getRoles()
getSiteGroups
(boolean includeAdministrative) long[]
getTeams()
getUnlockDate
(PasswordPolicy passwordPolicy) long[]
boolean
boolean
hasCompanyMx
(String emailAddress) boolean
boolean
boolean
boolean
boolean
boolean
isActive()
boolean
Deprecated.As of Cavanaugh (7.4.x), replaced byisGuestUser()
boolean
boolean
boolean
isFemale()
boolean
boolean
isMale()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
void
setContact
(Contact contact) void
void
setGroupId
(long groupId) void
setGroupIds
(long[] groupIds) void
setOrganizationIds
(long[] organizationIds) void
setPasswordModified
(boolean passwordModified) void
setPasswordUnencrypted
(String passwordUnencrypted) void
setRoleIds
(long[] roleIds) void
setTeamIds
(long[] teamIds) void
setUserGroupIds
(long[] userGroupIds) Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, 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.PersistedModel
persist
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
Methods inherited from interface com.liferay.portal.kernel.model.UserModel
cloneWithOriginalValues, getAgreedToTermsOfUse, getComments, getCompanyId, getContactId, getCreateDate, getCtCollectionId, getDigest, getEmailAddress, getEmailAddressVerified, getExternalReferenceCode, getFacebookId, getFailedLoginAttempts, getFirstName, getGoogleUserId, getGraceLoginCount, getGreeting, getJobTitle, getLanguageId, getLastFailedLoginDate, getLastLoginDate, getLastLoginIP, getLastName, getLdapServerId, getLockout, getLockoutDate, getLoginDate, getLoginIP, getMiddleName, getModifiedDate, getMvccVersion, getOpenId, getPassword, getPasswordEncrypted, getPasswordModifiedDate, getPasswordReset, getPortraitId, getPrimaryKey, getReminderQueryAnswer, getReminderQueryQuestion, getScreenName, getStatus, getTimeZoneId, getType, getUserId, getUserUuid, getUuid, isAgreedToTermsOfUse, isEmailAddressVerified, isLockout, isPasswordEncrypted, isPasswordReset, setAgreedToTermsOfUse, setComments, setCompanyId, setContactId, setCreateDate, setCtCollectionId, setDigest, setEmailAddress, setEmailAddressVerified, setExternalReferenceCode, setFacebookId, setFailedLoginAttempts, setFirstName, setGoogleUserId, setGraceLoginCount, setGreeting, setJobTitle, setLanguageId, setLastFailedLoginDate, setLastLoginDate, setLastLoginIP, setLastName, setLdapServerId, setLockout, setLockoutDate, setLoginDate, setLoginIP, setMiddleName, setModifiedDate, setMvccVersion, setOpenId, setPassword, setPasswordEncrypted, setPasswordModifiedDate, setPasswordReset, setPortraitId, setPrimaryKey, setReminderQueryAnswer, setReminderQueryQuestion, setScreenName, setStatus, setTimeZoneId, setType, setUserId, setUserUuid, setUuid, toXmlString
-
Field Details
-
USER_ID_ACCESSOR
-
-
Method Details
-
fetchContact
Contact fetchContact() -
fetchPortraitURL
-
getAddresses
Returns the user's addresses.- Returns:
- the user's addresses
-
getAllGroups
- Throws:
PortalException
-
getAllRoles
- Throws:
PortalException
-
getBirthday
Returns the user's birth date.- Returns:
- the user's birth date
- Throws:
PortalException
-
getCompanyMx
Returns the user's company's mail domain.- Returns:
- the user's company's mail domain
- Throws:
PortalException
-
getContact
Returns the user's associated contact.- Returns:
- the user's associated contact
- Throws:
PortalException
- See Also:
-
getDigest
Deprecated.As of Cavanaugh (7.4.x), with no direct replacementReturns a digest for the user, incorporating the password.- Parameters:
password
- a password to incorporate with the digest- Returns:
- a digest for the user, incorporating the password
-
getDisplayEmailAddress
String getDisplayEmailAddress()Returns the user's primary email address, or a blank string if the address is fake.- 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.
- Parameters:
themeDisplay
- the theme display- Returns:
- the user's display URL
- Throws:
PortalException
-
getDisplayURL
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.
- 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
-
getEmailAddresses
List<EmailAddress> getEmailAddresses()Returns the user's email addresses.- Returns:
- the user's email addresses
-
getFemale
Returnstrue
if the user is female.- Returns:
true
if the user is female;false
otherwise- Throws:
PortalException
-
getFullName
Returns the user's full name.- Returns:
- the user's full name
-
getFullName
Returns the user's full name.- Returns:
- the user's full name
-
getGroup
Group getGroup() -
getGroupId
long getGroupId() -
getGroupIds
long[] getGroupIds() -
getGroups
-
getInheritedGroups
- Throws:
PortalException
-
getInheritedRoles
- Throws:
PortalException
-
getInheritedSiteGroups
- Throws:
PortalException
-
getInheritedSiteRoles
-
getInitials
String getInitials() -
getLocale
Locale getLocale() -
getLogin
- Throws:
PortalException
-
getMale
Returnstrue
if the user is male.- Returns:
true
if the user is male;false
otherwise- Throws:
PortalException
-
getMySiteGroups
- Throws:
PortalException
-
getMySiteGroups
- Throws:
PortalException
-
getMySiteGroups
- Throws:
PortalException
-
getOrganizationIds
- Throws:
PortalException
-
getOrganizationIds
- Throws:
PortalException
-
getOrganizations
- Throws:
PortalException
-
getOrganizations
- Throws:
PortalException
-
getOrganizations
List<Organization> getOrganizations(boolean includeAdministrative, boolean includeParentOrganizations) throws PortalException - Throws:
PortalException
-
getOrganizationsGroups
- Throws:
PortalException
-
getOrganizationsRoles
- Throws:
PortalException
-
getOriginalEmailAddress
String getOriginalEmailAddress() -
getPasswordModified
boolean getPasswordModified() -
getPasswordPolicy
- Throws:
PortalException
-
getPasswordUnencrypted
String getPasswordUnencrypted() -
getPhones
-
getPortraitURL
- Throws:
PortalException
-
getPrivateLayoutsPageCount
- Throws:
PortalException
-
getPublicLayoutsPageCount
- Throws:
PortalException
-
getReminderQueryQuestions
- Throws:
PortalException
-
getRoleIds
long[] getRoleIds() -
getRoles
-
getSiteGroups
- Throws:
PortalException
-
getSiteGroups
- Throws:
PortalException
-
getSiteRoles
- Throws:
PortalException
-
getTeamIds
long[] getTeamIds() -
getTeams
-
getTimeZone
TimeZone getTimeZone() -
getUnlockDate
- Throws:
PortalException
-
getUnlockDate
-
getUserGroupIds
long[] getUserGroupIds() -
getUserGroupRoles
- Throws:
PortalException
-
getUserGroups
-
getWebsites
-
hasCompanyMx
- Throws:
PortalException
-
hasCompanyMx
- Throws:
PortalException
-
hasMySites
- Throws:
PortalException
-
hasOrganization
boolean hasOrganization() -
hasPrivateLayouts
- Throws:
PortalException
-
hasPublicLayouts
- Throws:
PortalException
-
hasReminderQuery
boolean hasReminderQuery() -
isActive
boolean isActive() -
isDefaultUser
Deprecated.As of Cavanaugh (7.4.x), replaced byisGuestUser()
-
isEmailAddressComplete
boolean isEmailAddressComplete() -
isEmailAddressVerificationComplete
boolean isEmailAddressVerificationComplete() -
isFemale
- Throws:
PortalException
-
isGuestUser
boolean isGuestUser() -
isMale
- Throws:
PortalException
-
isOnDemandUser
boolean isOnDemandUser() -
isPasswordModified
boolean isPasswordModified() -
isPasswordResetRequired
boolean isPasswordResetRequired() -
isReminderQueryComplete
boolean isReminderQueryComplete() -
isServiceAccountUser
boolean isServiceAccountUser() -
isSetupComplete
boolean isSetupComplete() -
isTermsOfUseComplete
boolean isTermsOfUseComplete() -
setContact
-
setGroup
-
setGroupId
void setGroupId(long groupId) -
setGroupIds
void setGroupIds(long[] groupIds) -
setOrganizationIds
void setOrganizationIds(long[] organizationIds) -
setPasswordModified
void setPasswordModified(boolean passwordModified) -
setPasswordUnencrypted
-
setRoleIds
void setRoleIds(long[] roleIds) -
setTeamIds
void setTeamIds(long[] teamIds) -
setUserGroupIds
void setUserGroupIds(long[] userGroupIds)
-