@ProviderType public interface User extends UserModel, PersistedModel
UserModel,
UserImpl,
UserModelImpl| Modifier and Type | Field and Description |
|---|---|
static Accessor<User,java.lang.Long> |
USER_ID_ACCESSOR |
| Modifier and Type | Method and Description |
|---|---|
void |
addRemotePreference(RemotePreference remotePreference) |
Contact |
fetchContact() |
java.util.List<Address> |
getAddresses()
Returns the user's addresses.
|
java.util.Date |
getBirthday()
Returns the user's birth date.
|
java.lang.String |
getCompanyMx()
Returns the user's company's mail domain.
|
Contact |
getContact()
Returns the user's associated contact.
|
java.lang.String |
getDigest(java.lang.String password)
Returns a digest for the user, incorporating the password.
|
java.lang.String |
getDisplayEmailAddress()
Returns the user's primary email address, or a blank string if the
address is fake.
|
java.lang.String |
getDisplayURL(java.lang.String portalURL,
java.lang.String mainPath)
Deprecated.
As of 7.0.0, replaced by
getDisplayURL(ThemeDisplay) |
java.lang.String |
getDisplayURL(java.lang.String portalURL,
java.lang.String mainPath,
boolean privateLayout)
Deprecated.
As of 7.0.0, replaced by
getDisplayURL(ThemeDisplay) |
java.lang.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.
|
java.lang.String |
getDisplayURL(ThemeDisplay themeDisplay,
boolean privateLayout)
Returns the user's display URL based on the theme display.
|
java.util.List<EmailAddress> |
getEmailAddresses()
Returns the user's email addresses.
|
boolean |
getFemale()
Returns
true if the user is female. |
java.lang.String |
getFullName()
Returns the user's full name.
|
java.lang.String |
getFullName(boolean usePrefix,
boolean useSuffix)
Returns the user's full name.
|
Group |
getGroup() |
long |
getGroupId() |
long[] |
getGroupIds() |
java.util.List<Group> |
getGroups() |
java.lang.String |
getInitials() |
java.util.Locale |
getLocale() |
java.lang.String |
getLogin() |
boolean |
getMale()
Returns
true if the user is male. |
java.util.List<Group> |
getMySiteGroups() |
java.util.List<Group> |
getMySiteGroups(int max) |
java.util.List<Group> |
getMySiteGroups(java.lang.String[] classNames,
int max) |
java.util.List<Group> |
getMySites()
Deprecated.
As of 6.2.0, replaced by
getMySiteGroups() |
java.util.List<Group> |
getMySites(boolean includeControlPanel,
int max)
Deprecated.
As of 6.2.0, replaced by
getMySiteGroups(int) |
java.util.List<Group> |
getMySites(int max)
Deprecated.
As of 6.2.0, replaced by
getMySiteGroups(int) |
java.util.List<Group> |
getMySites(java.lang.String[] classNames,
boolean includeControlPanel,
int max)
Deprecated.
As of 6.2.0, replaced by
getMySiteGroups(String[],
int) |
java.util.List<Group> |
getMySites(java.lang.String[] classNames,
int max)
Deprecated.
As of 6.2.0, replaced by
getMySiteGroups(String[],
int) |
long[] |
getOrganizationIds() |
long[] |
getOrganizationIds(boolean includeAdministrative) |
java.util.List<Organization> |
getOrganizations() |
java.util.List<Organization> |
getOrganizations(boolean includeAdministrative) |
java.lang.String |
getOriginalEmailAddress() |
boolean |
getPasswordModified() |
PasswordPolicy |
getPasswordPolicy() |
java.lang.String |
getPasswordUnencrypted() |
java.util.List<Phone> |
getPhones() |
java.lang.String |
getPortraitURL(ThemeDisplay themeDisplay) |
int |
getPrivateLayoutsPageCount() |
int |
getPublicLayoutsPageCount() |
java.util.Set<java.lang.String> |
getReminderQueryQuestions() |
RemotePreference |
getRemotePreference(java.lang.String name) |
java.lang.Iterable<RemotePreference> |
getRemotePreferences() |
long[] |
getRoleIds() |
java.util.List<Role> |
getRoles() |
java.util.List<Group> |
getSiteGroups() |
java.util.List<Group> |
getSiteGroups(boolean includeAdministrative) |
long[] |
getTeamIds() |
java.util.List<Team> |
getTeams() |
java.util.TimeZone |
getTimeZone() |
java.util.Date |
getUnlockDate() |
java.util.Date |
getUnlockDate(PasswordPolicy passwordPolicy) |
long[] |
getUserGroupIds() |
java.util.List<UserGroup> |
getUserGroups() |
java.util.List<Website> |
getWebsites() |
boolean |
hasCompanyMx() |
boolean |
hasCompanyMx(java.lang.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(java.lang.String passwordUnencrypted) |
clone, compareTo, getAgreedToTermsOfUse, getComments, getCompanyId, getContactId, getCreateDate, getDefaultUser, getDigest, getEmailAddress, getEmailAddressVerified, getExpandoBridge, getFacebookId, getFailedLoginAttempts, getFirstName, getGraceLoginCount, getGreeting, getJobTitle, getLanguageId, getLastFailedLoginDate, getLastLoginDate, getLastLoginIP, getLastName, getLdapServerId, getLockout, getLockoutDate, getLoginDate, getLoginIP, getMiddleName, getModifiedDate, getMvccVersion, getOpenId, getPassword, getPasswordEncrypted, getPasswordModifiedDate, getPasswordReset, getPortraitId, getPrimaryKey, getPrimaryKeyObj, getReminderQueryAnswer, getReminderQueryQuestion, getScreenName, getStatus, getTimeZoneId, getUserId, getUserUuid, getUuid, hashCode, isAgreedToTermsOfUse, isCachedModel, isDefaultUser, isEmailAddressVerified, isEscapedModel, isLockout, isNew, isPasswordEncrypted, isPasswordReset, setAgreedToTermsOfUse, setCachedModel, setComments, setCompanyId, setContactId, setCreateDate, setDefaultUser, setDigest, setEmailAddress, setEmailAddressVerified, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setFacebookId, setFailedLoginAttempts, setFirstName, setGraceLoginCount, setGreeting, setJobTitle, setLanguageId, setLastFailedLoginDate, setLastLoginDate, setLastLoginIP, setLastName, setLdapServerId, setLockout, setLockoutDate, setLoginDate, setLoginIP, setMiddleName, setModifiedDate, setMvccVersion, setNew, setOpenId, setPassword, setPasswordEncrypted, setPasswordModifiedDate, setPasswordReset, setPortraitId, setPrimaryKey, setPrimaryKeyObj, setReminderQueryAnswer, setReminderQueryQuestion, setScreenName, setStatus, setTimeZoneId, setUserId, setUserUuid, setUuid, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlStringgetModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributesgetStagedModelTypegetModelClass, getModelClassNamepersistvoid addRemotePreference(RemotePreference remotePreference)
Contact fetchContact()
java.util.List<Address> getAddresses()
java.util.Date getBirthday()
throws PortalException
PortalExceptionjava.lang.String getCompanyMx()
throws PortalException
PortalExceptionContact getContact() throws PortalException
PortalExceptionContactjava.lang.String getDigest(java.lang.String password)
password - a password to incorporate with the digestjava.lang.String getDisplayEmailAddress()
@Deprecated
java.lang.String getDisplayURL(java.lang.String portalURL,
java.lang.String mainPath)
throws PortalException
getDisplayURL(ThemeDisplay)The logic for the display URL to return is as follows:
portalURL - the portal's URLmainPath - the main pathPortalException@Deprecated
java.lang.String getDisplayURL(java.lang.String portalURL,
java.lang.String mainPath,
boolean privateLayout)
throws PortalException
getDisplayURL(ThemeDisplay)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.
portalURL - the portal's URLmainPath - the main pathprivateLayout - 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 profilePortalExceptionjava.lang.String getDisplayURL(ThemeDisplay themeDisplay) throws PortalException
The logic for the display URL to return is as follows:
themeDisplay - the theme displayPortalExceptionjava.lang.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 profilePortalExceptionjava.util.List<EmailAddress> getEmailAddresses()
boolean getFemale()
throws PortalException
true if the user is female.true if the user is female; false
otherwisePortalException@AutoEscape java.lang.String getFullName()
@AutoEscape java.lang.String getFullName(boolean usePrefix, boolean useSuffix)
Group getGroup()
long getGroupId()
long[] getGroupIds()
java.util.List<Group> getGroups()
java.lang.String getInitials()
java.util.Locale getLocale()
java.lang.String getLogin()
throws PortalException
PortalExceptionboolean getMale()
throws PortalException
true if the user is male.true if the user is male; false
otherwisePortalExceptionjava.util.List<Group> getMySiteGroups() throws PortalException
PortalExceptionjava.util.List<Group> getMySiteGroups(int max) throws PortalException
PortalExceptionjava.util.List<Group> getMySiteGroups(java.lang.String[] classNames, int max) throws PortalException
PortalException@Deprecated java.util.List<Group> getMySites() throws PortalException
getMySiteGroups()PortalException@Deprecated java.util.List<Group> getMySites(boolean includeControlPanel, int max) throws PortalException
getMySiteGroups(int)PortalException@Deprecated java.util.List<Group> getMySites(int max) throws PortalException
getMySiteGroups(int)PortalException@Deprecated java.util.List<Group> getMySites(java.lang.String[] classNames, boolean includeControlPanel, int max) throws PortalException
getMySiteGroups(String[],
int)PortalException@Deprecated java.util.List<Group> getMySites(java.lang.String[] classNames, int max) throws PortalException
getMySiteGroups(String[],
int)PortalExceptionlong[] getOrganizationIds()
throws PortalException
PortalExceptionlong[] getOrganizationIds(boolean includeAdministrative)
throws PortalException
PortalExceptionjava.util.List<Organization> getOrganizations() throws PortalException
PortalExceptionjava.util.List<Organization> getOrganizations(boolean includeAdministrative) throws PortalException
PortalExceptionjava.lang.String getOriginalEmailAddress()
boolean getPasswordModified()
PasswordPolicy getPasswordPolicy() throws PortalException
PortalExceptionjava.lang.String getPasswordUnencrypted()
java.util.List<Phone> getPhones()
java.lang.String getPortraitURL(ThemeDisplay themeDisplay) throws PortalException
PortalExceptionint getPrivateLayoutsPageCount()
throws PortalException
PortalExceptionint getPublicLayoutsPageCount()
throws PortalException
PortalExceptionjava.util.Set<java.lang.String> getReminderQueryQuestions()
throws PortalException
PortalExceptionRemotePreference getRemotePreference(java.lang.String name)
java.lang.Iterable<RemotePreference> getRemotePreferences()
long[] getRoleIds()
java.util.List<Role> getRoles()
java.util.List<Group> getSiteGroups() throws PortalException
PortalExceptionjava.util.List<Group> getSiteGroups(boolean includeAdministrative) throws PortalException
PortalExceptionlong[] getTeamIds()
java.util.List<Team> getTeams()
java.util.TimeZone getTimeZone()
java.util.Date getUnlockDate()
throws PortalException
PortalExceptionjava.util.Date getUnlockDate(PasswordPolicy passwordPolicy)
long[] getUserGroupIds()
java.util.List<UserGroup> getUserGroups()
java.util.List<Website> getWebsites()
boolean hasCompanyMx()
throws PortalException
PortalExceptionboolean hasCompanyMx(java.lang.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(java.lang.String passwordUnencrypted)