@ProviderType public interface User extends PersistedModel, UserModel
UserModel| Modifier and Type | Field and Description |
|---|---|
static Accessor<User,Long> |
USER_ID_ACCESSOR
NOTE FOR DEVELOPERS:
Never modify this interface directly.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addRemotePreference(RemotePreference remotePreference) |
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)
Returns a digest for the user, incorporating the password.
|
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() |
RemotePreference |
getRemotePreference(String name) |
Iterable<RemotePreference> |
getRemotePreferences() |
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 |
isEmailAddressComplete() |
boolean |
isEmailAddressVerificationComplete() |
boolean |
isFemale() |
boolean |
isMale() |
boolean |
isPasswordModified() |
boolean |
isReminderQueryComplete() |
boolean |
isSetupComplete() |
boolean |
isTermsOfUseComplete() |
void |
setPasswordModified(boolean passwordModified) |
void |
setPasswordUnencrypted(String passwordUnencrypted) |
persistgetAgreedToTermsOfUse, getComments, getCompanyId, getContactId, getCreateDate, getDefaultUser, 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, getUserId, getUserUuid, getUuid, isAgreedToTermsOfUse, isDefaultUser, isEmailAddressVerified, isLockout, isPasswordEncrypted, isPasswordReset, setAgreedToTermsOfUse, setComments, setCompanyId, setContactId, setCreateDate, setDefaultUser, 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, setUserId, setUserUuid, setUuidclone, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlStringclone, getStagedModelTypegetModelClass, getModelClassNamevoid addRemotePreference(RemotePreference remotePreference)
Contact fetchContact()
String fetchPortraitURL(ThemeDisplay themeDisplay)
List<Address> getAddresses()
Date getBirthday()
throws PortalException
PortalExceptionString getCompanyMx()
throws PortalException
PortalExceptionContact getContact() throws PortalException
PortalExceptionContactString 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 displayPortalExceptionString 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 profilePortalExceptionList<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
PortalExceptionboolean getMale()
throws PortalException
true if the user is male.true if the user is male; false
otherwisePortalExceptionList<Group> getMySiteGroups() throws PortalException
PortalExceptionList<Group> getMySiteGroups(int max) throws PortalException
PortalExceptionList<Group> getMySiteGroups(String[] classNames, int max) throws PortalException
PortalExceptionlong[] getOrganizationIds()
throws PortalException
PortalExceptionlong[] getOrganizationIds(boolean includeAdministrative)
throws PortalException
PortalExceptionList<Organization> getOrganizations() throws PortalException
PortalExceptionList<Organization> getOrganizations(boolean includeAdministrative) throws PortalException
PortalExceptionString getOriginalEmailAddress()
boolean getPasswordModified()
PasswordPolicy getPasswordPolicy() throws PortalException
PortalExceptionString getPasswordUnencrypted()
List<Phone> getPhones()
String getPortraitURL(ThemeDisplay themeDisplay) throws PortalException
PortalExceptionint getPrivateLayoutsPageCount()
throws PortalException
PortalExceptionint getPublicLayoutsPageCount()
throws PortalException
PortalExceptionSet<String> getReminderQueryQuestions()
throws PortalException
PortalExceptionRemotePreference getRemotePreference(String name)
Iterable<RemotePreference> getRemotePreferences()
long[] getRoleIds()
List<Role> getRoles()
List<Group> getSiteGroups() throws PortalException
PortalExceptionList<Group> getSiteGroups(boolean includeAdministrative) throws PortalException
PortalExceptionlong[] getTeamIds()
List<Team> getTeams()
TimeZone getTimeZone()
Date getUnlockDate()
throws PortalException
PortalExceptionDate getUnlockDate(PasswordPolicy passwordPolicy)
long[] getUserGroupIds()
List<UserGroup> getUserGroups()
List<Website> getWebsites()
boolean hasCompanyMx()
throws PortalException
PortalExceptionboolean hasCompanyMx(String emailAddress)
throws PortalException
PortalExceptionboolean hasMySites()
throws PortalException
PortalExceptionboolean hasOrganization()
boolean hasPrivateLayouts()
throws PortalException
PortalExceptionboolean hasPublicLayouts()
throws PortalException
PortalExceptionboolean hasReminderQuery()
boolean isActive()
boolean isEmailAddressComplete()
boolean isEmailAddressVerificationComplete()
boolean isFemale()
throws PortalException
PortalExceptionboolean isMale()
throws PortalException
PortalExceptionboolean isPasswordModified()
boolean isReminderQueryComplete()
boolean isSetupComplete()
boolean isTermsOfUseComplete()
void setPasswordModified(boolean passwordModified)
void setPasswordUnencrypted(String passwordUnencrypted)