@ProviderType public interface User extends PersistedModel, UserModel
UserModel
Modifier and Type | Field and Description |
---|---|
static Accessor<User,Long> |
USER_ID_ACCESSOR |
Modifier and Type | Method and Description |
---|---|
Contact |
fetchContact() |
String |
fetchPortraitURL(ThemeDisplay themeDisplay) |
List<Address> |
getAddresses()
Returns the user's addresses.
|
Date |
getBirthday()
Returns the user's birth date.
|
String |
getCompanyMx()
Returns the user's company's mail domain.
|
Contact |
getContact()
Returns the user's associated contact.
|
String |
getDigest(String password)
Deprecated.
As of Cavanaugh (7.4.x), with no direct replacement
|
String |
getDisplayEmailAddress()
Returns the user's primary email address, or a blank string if the
address is fake.
|
String |
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.
|
String |
getDisplayURL(ThemeDisplay themeDisplay,
boolean privateLayout)
Returns the user's display URL based on the theme display.
|
List<EmailAddress> |
getEmailAddresses()
Returns the user's email addresses.
|
boolean |
getFemale()
Returns
true if the user is female. |
String |
getFullName()
Returns the user's full name.
|
String |
getFullName(boolean usePrefix,
boolean useSuffix)
Returns the user's full name.
|
Group |
getGroup() |
long |
getGroupId() |
long[] |
getGroupIds() |
List<Group> |
getGroups() |
String |
getInitials() |
Locale |
getLocale() |
String |
getLogin() |
boolean |
getMale()
Returns
true if the user is male. |
List<Group> |
getMySiteGroups() |
List<Group> |
getMySiteGroups(int max) |
List<Group> |
getMySiteGroups(String[] classNames,
int max) |
long[] |
getOrganizationIds() |
long[] |
getOrganizationIds(boolean includeAdministrative) |
List<Organization> |
getOrganizations() |
List<Organization> |
getOrganizations(boolean includeAdministrative) |
String |
getOriginalEmailAddress() |
boolean |
getPasswordModified() |
PasswordPolicy |
getPasswordPolicy() |
String |
getPasswordUnencrypted() |
List<Phone> |
getPhones() |
String |
getPortraitURL(ThemeDisplay themeDisplay) |
int |
getPrivateLayoutsPageCount() |
int |
getPublicLayoutsPageCount() |
Set<String> |
getReminderQueryQuestions() |
long[] |
getRoleIds() |
List<Role> |
getRoles() |
List<Group> |
getSiteGroups() |
List<Group> |
getSiteGroups(boolean includeAdministrative) |
long[] |
getTeamIds() |
List<Team> |
getTeams() |
TimeZone |
getTimeZone() |
Date |
getUnlockDate() |
Date |
getUnlockDate(PasswordPolicy passwordPolicy) |
long[] |
getUserGroupIds() |
List<UserGroup> |
getUserGroups() |
List<Website> |
getWebsites() |
boolean |
hasCompanyMx() |
boolean |
hasCompanyMx(String emailAddress) |
boolean |
hasMySites() |
boolean |
hasOrganization() |
boolean |
hasPrivateLayouts() |
boolean |
hasPublicLayouts() |
boolean |
hasReminderQuery() |
boolean |
isActive() |
boolean |
isDefaultUser()
Deprecated.
As of Cavanaugh (7.4.x), replaced by
isGuestUser() |
boolean |
isEmailAddressComplete() |
boolean |
isEmailAddressVerificationComplete() |
boolean |
isFemale() |
boolean |
isGuestUser() |
boolean |
isMale() |
boolean |
isOnDemandUser() |
boolean |
isPasswordModified() |
boolean |
isPasswordResetRequired() |
boolean |
isReminderQueryComplete() |
boolean |
isServiceAccountUser() |
boolean |
isSetupComplete() |
boolean |
isTermsOfUseComplete() |
void |
setContact(Contact contact) |
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) |
persist
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
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
getModelClass, getModelClassName
clone, getStagedModelType
Contact fetchContact()
String fetchPortraitURL(ThemeDisplay themeDisplay)
List<Address> getAddresses()
Date getBirthday() throws PortalException
PortalException
String getCompanyMx() throws PortalException
PortalException
Contact getContact() throws PortalException
PortalException
Contact
@Deprecated String getDigest(String password)
password
- a password to incorporate with the digestString getDisplayEmailAddress()
String getDisplayURL(ThemeDisplay themeDisplay) throws PortalException
The logic for the display URL to return is as follows:
themeDisplay
- the theme displayPortalException
String getDisplayURL(ThemeDisplay themeDisplay, boolean privateLayout) throws PortalException
The logic for the display URL to return is as follows:
privateLayout
is true
, return the URL
of the user's default intranet site home page.
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 profilePortalException
List<EmailAddress> getEmailAddresses()
boolean getFemale() throws PortalException
true
if the user is female.true
if the user is female; false
otherwisePortalException
@AutoEscape String getFullName()
@AutoEscape String getFullName(boolean usePrefix, boolean useSuffix)
Group getGroup()
long getGroupId()
long[] getGroupIds()
List<Group> getGroups()
String getInitials()
Locale getLocale()
String getLogin() throws PortalException
PortalException
boolean getMale() throws PortalException
true
if the user is male.true
if the user is male; false
otherwisePortalException
List<Group> getMySiteGroups() throws PortalException
PortalException
List<Group> getMySiteGroups(int max) throws PortalException
PortalException
List<Group> getMySiteGroups(String[] classNames, int max) throws PortalException
PortalException
long[] getOrganizationIds() throws PortalException
PortalException
long[] getOrganizationIds(boolean includeAdministrative) throws PortalException
PortalException
List<Organization> getOrganizations() throws PortalException
PortalException
List<Organization> getOrganizations(boolean includeAdministrative) throws PortalException
PortalException
String getOriginalEmailAddress()
boolean getPasswordModified()
PasswordPolicy getPasswordPolicy() throws PortalException
PortalException
String getPasswordUnencrypted()
List<Phone> getPhones()
String getPortraitURL(ThemeDisplay themeDisplay) throws PortalException
PortalException
int getPrivateLayoutsPageCount() throws PortalException
PortalException
int getPublicLayoutsPageCount() throws PortalException
PortalException
Set<String> getReminderQueryQuestions() throws PortalException
PortalException
long[] getRoleIds()
List<Role> getRoles()
List<Group> getSiteGroups() throws PortalException
PortalException
List<Group> getSiteGroups(boolean includeAdministrative) throws PortalException
PortalException
long[] getTeamIds()
List<Team> getTeams()
TimeZone getTimeZone()
Date getUnlockDate() throws PortalException
PortalException
Date getUnlockDate(PasswordPolicy passwordPolicy)
long[] getUserGroupIds()
List<UserGroup> getUserGroups()
List<Website> getWebsites()
boolean hasCompanyMx() throws PortalException
PortalException
boolean hasCompanyMx(String emailAddress) throws PortalException
PortalException
boolean hasMySites() throws PortalException
PortalException
boolean hasOrganization()
boolean hasPrivateLayouts() throws PortalException
PortalException
boolean hasPublicLayouts() throws PortalException
PortalException
boolean hasReminderQuery()
boolean isActive()
@Deprecated boolean isDefaultUser()
isGuestUser()
boolean isEmailAddressComplete()
boolean isEmailAddressVerificationComplete()
boolean isFemale() throws PortalException
PortalException
boolean isGuestUser()
boolean isMale() throws PortalException
PortalException
boolean isOnDemandUser()
boolean isPasswordModified()
boolean isPasswordResetRequired()
boolean isReminderQueryComplete()
boolean isServiceAccountUser()
boolean isSetupComplete()
boolean isTermsOfUseComplete()
void setContact(Contact contact)
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)