|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.model.impl.BaseModelImpl<User>
com.liferay.portal.model.impl.UserModelImpl
com.liferay.portal.model.impl.UserBaseImpl
com.liferay.portal.model.impl.UserImpl
public class UserImpl
Represents a portal user, providing access to the user's contact information, groups, organizations, teams, user groups, roles, locale, timezone, and more.
| Field Summary |
|---|
| Fields inherited from interface com.liferay.portal.model.User |
|---|
USER_ID_ACCESSOR |
| Constructor Summary | |
|---|---|
UserImpl()
|
|
| Method Summary | |
|---|---|
void |
addRemotePreference(RemotePreference remotePreference)
|
Contact |
fetchContact()
|
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()
Returns the user's digest. |
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(String portalURL,
String mainPath)
Deprecated. As of 7.0.0, replaced by getDisplayURL(ThemeDisplay) |
String |
getDisplayURL(String portalURL,
String mainPath,
boolean privateLayout)
Deprecated. As of 7.0.0, replaced by getDisplayURL(ThemeDisplay) |
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()
|
protected String |
getProfileFriendlyURL()
|
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 |
setLanguageId(String languageId)
Sets the language ID of this user. |
void |
setPasswordModified(boolean passwordModified)
|
void |
setPasswordUnencrypted(String passwordUnencrypted)
|
void |
setTimeZoneId(String timeZoneId)
Sets the time zone ID of this user. |
| Methods inherited from class com.liferay.portal.model.impl.UserBaseImpl |
|---|
persist |
| Methods inherited from class com.liferay.portal.model.impl.BaseModelImpl |
|---|
getLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, toUnescapedModel |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.liferay.portal.model.BaseModel |
|---|
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes |
| Methods inherited from interface com.liferay.portal.model.StagedModel |
|---|
getStagedModelType |
| Methods inherited from interface com.liferay.portal.model.ClassedModel |
|---|
getModelClass, getModelClassName |
| Constructor Detail |
|---|
public UserImpl()
| Method Detail |
|---|
public void addRemotePreference(RemotePreference remotePreference)
public Contact fetchContact()
public List<Address> getAddresses()
public Date getBirthday()
throws PortalException
PortalException
public String getCompanyMx()
throws PortalException
PortalException
public Contact getContact()
throws PortalException
PortalExceptionContactpublic String getDigest()
getDigest in interface UserModelgetDigest in class UserModelImplpublic String getDigest(String password)
password - a password to incorporate with the digest
public String getDisplayEmailAddress()
@Deprecated
public String getDisplayURL(String portalURL,
String mainPath)
throws PortalException
getDisplayURL(ThemeDisplay)
The logic for the display URL to return is as follows:
portalURL - the portal's URLmainPath - the main path
PortalException
@Deprecated
public String getDisplayURL(String portalURL,
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 profile
PortalException
PortalException
public String getDisplayURL(ThemeDisplay themeDisplay)
throws PortalException
The logic for the display URL to return is as follows:
themeDisplay - the theme display
PortalException
public 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 profile
PortalException
PortalExceptionpublic List<EmailAddress> getEmailAddresses()
public boolean getFemale()
throws PortalException
true if the user is female.
true if the user is female; false
otherwise
PortalException@AutoEscape public String getFullName()
@AutoEscape
public String getFullName(boolean usePrefix,
boolean useSuffix)
public Group getGroup()
public long getGroupId()
public long[] getGroupIds()
public List<Group> getGroups()
public String getInitials()
public Locale getLocale()
public String getLogin()
throws PortalException
PortalException
public boolean getMale()
throws PortalException
true if the user is male.
true if the user is male; false
otherwise
PortalException
public List<Group> getMySiteGroups()
throws PortalException
PortalException
public List<Group> getMySiteGroups(int max)
throws PortalException
PortalException
public List<Group> getMySiteGroups(String[] classNames,
int max)
throws PortalException
PortalException
public long[] getOrganizationIds()
throws PortalException
PortalException
public long[] getOrganizationIds(boolean includeAdministrative)
throws PortalException
PortalException
public List<Organization> getOrganizations()
throws PortalException
PortalException
public List<Organization> getOrganizations(boolean includeAdministrative)
throws PortalException
PortalExceptionpublic String getOriginalEmailAddress()
getOriginalEmailAddress in interface UsergetOriginalEmailAddress in class UserModelImplpublic boolean getPasswordModified()
public PasswordPolicy getPasswordPolicy()
throws PortalException
PortalExceptionpublic String getPasswordUnencrypted()
public List<Phone> getPhones()
public String getPortraitURL(ThemeDisplay themeDisplay)
throws PortalException
PortalException
public int getPrivateLayoutsPageCount()
throws PortalException
PortalException
public int getPublicLayoutsPageCount()
throws PortalException
PortalException
public Set<String> getReminderQueryQuestions()
throws PortalException
PortalExceptionpublic RemotePreference getRemotePreference(String name)
public Iterable<RemotePreference> getRemotePreferences()
public long[] getRoleIds()
public List<Role> getRoles()
public List<Group> getSiteGroups()
throws PortalException
PortalException
public List<Group> getSiteGroups(boolean includeAdministrative)
throws PortalException
PortalExceptionpublic long[] getTeamIds()
public List<Team> getTeams()
public TimeZone getTimeZone()
public Date getUnlockDate()
throws PortalException
PortalExceptionpublic Date getUnlockDate(PasswordPolicy passwordPolicy)
public long[] getUserGroupIds()
public List<UserGroup> getUserGroups()
public List<Website> getWebsites()
public boolean hasCompanyMx()
throws PortalException
PortalException
public boolean hasCompanyMx(String emailAddress)
throws PortalException
PortalException
public boolean hasMySites()
throws PortalException
PortalExceptionpublic boolean hasOrganization()
public boolean hasPrivateLayouts()
throws PortalException
PortalException
public boolean hasPublicLayouts()
throws PortalException
PortalExceptionpublic boolean hasReminderQuery()
public boolean isActive()
public boolean isEmailAddressComplete()
public boolean isEmailAddressVerificationComplete()
public boolean isFemale()
throws PortalException
PortalException
public boolean isMale()
throws PortalException
PortalExceptionpublic boolean isPasswordModified()
public boolean isReminderQueryComplete()
public boolean isSetupComplete()
public boolean isTermsOfUseComplete()
public void setLanguageId(String languageId)
UserModel
setLanguageId in interface UserModelsetLanguageId in class UserModelImpllanguageId - the language ID of this userpublic void setPasswordModified(boolean passwordModified)
public void setPasswordUnencrypted(String passwordUnencrypted)
public void setTimeZoneId(String timeZoneId)
UserModel
setTimeZoneId in interface UserModelsetTimeZoneId in class UserModelImpltimeZoneId - the time zone ID of this userprotected String getProfileFriendlyURL()
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||