|
Liferay 7.0-ce-b8 portal-impl | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.kernel.model.impl.BaseModelImpl<com.liferay.portal.kernel.model.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.kernel.model.User |
|---|
USER_ID_ACCESSOR |
| Constructor Summary | |
|---|---|
UserImpl()
|
|
| Method Summary | |
|---|---|
void |
addRemotePreference(com.liferay.portal.kernel.util.RemotePreference remotePreference)
|
com.liferay.portal.kernel.model.Contact |
fetchContact()
|
List<com.liferay.portal.kernel.model.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. |
com.liferay.portal.kernel.model.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(com.liferay.portal.kernel.theme.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(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
boolean privateLayout)
Returns the user's display URL based on the theme display. |
List<com.liferay.portal.kernel.model.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. |
com.liferay.portal.kernel.model.Group |
getGroup()
|
long |
getGroupId()
|
long[] |
getGroupIds()
|
List<com.liferay.portal.kernel.model.Group> |
getGroups()
|
String |
getInitials()
|
Locale |
getLocale()
|
String |
getLogin()
|
boolean |
getMale()
Returns true if the user is male. |
List<com.liferay.portal.kernel.model.Group> |
getMySiteGroups()
|
List<com.liferay.portal.kernel.model.Group> |
getMySiteGroups(int max)
|
List<com.liferay.portal.kernel.model.Group> |
getMySiteGroups(String[] classNames,
int max)
|
long[] |
getOrganizationIds()
|
long[] |
getOrganizationIds(boolean includeAdministrative)
|
List<com.liferay.portal.kernel.model.Organization> |
getOrganizations()
|
List<com.liferay.portal.kernel.model.Organization> |
getOrganizations(boolean includeAdministrative)
|
String |
getOriginalEmailAddress()
|
boolean |
getPasswordModified()
|
com.liferay.portal.kernel.model.PasswordPolicy |
getPasswordPolicy()
|
String |
getPasswordUnencrypted()
|
List<com.liferay.portal.kernel.model.Phone> |
getPhones()
|
String |
getPortraitURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
|
int |
getPrivateLayoutsPageCount()
|
protected String |
getProfileFriendlyURL()
|
int |
getPublicLayoutsPageCount()
|
Set<String> |
getReminderQueryQuestions()
|
com.liferay.portal.kernel.util.RemotePreference |
getRemotePreference(String name)
|
Iterable<com.liferay.portal.kernel.util.RemotePreference> |
getRemotePreferences()
|
long[] |
getRoleIds()
|
List<com.liferay.portal.kernel.model.Role> |
getRoles()
|
List<com.liferay.portal.kernel.model.Group> |
getSiteGroups()
|
List<com.liferay.portal.kernel.model.Group> |
getSiteGroups(boolean includeAdministrative)
|
long[] |
getTeamIds()
|
List<com.liferay.portal.kernel.model.Team> |
getTeams()
|
TimeZone |
getTimeZone()
|
Date |
getUnlockDate()
|
Date |
getUnlockDate(com.liferay.portal.kernel.model.PasswordPolicy passwordPolicy)
|
long[] |
getUserGroupIds()
|
List<com.liferay.portal.kernel.model.UserGroup> |
getUserGroups()
|
List<com.liferay.portal.kernel.model.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)
|
void |
setPasswordModified(boolean passwordModified)
|
void |
setPasswordUnencrypted(String passwordUnencrypted)
|
void |
setTimeZoneId(String timeZoneId)
|
| Methods inherited from class com.liferay.portal.model.impl.UserBaseImpl |
|---|
persist |
| Methods inherited from class com.liferay.portal.kernel.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.kernel.model.UserModel |
|---|
clone, compareTo, getAgreedToTermsOfUse, getComments, getCompanyId, getContactId, getCreateDate, getDefaultUser, getEmailAddress, getEmailAddressVerified, getExpandoBridge, 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, 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, setGoogleUserId, setGraceLoginCount, setGreeting, setJobTitle, 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, setUserId, setUserUuid, setUuid, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString |
| Methods inherited from interface com.liferay.portal.kernel.model.BaseModel |
|---|
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes |
| Methods inherited from interface com.liferay.portal.kernel.model.StagedModel |
|---|
getStagedModelType |
| Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel |
|---|
getModelClass, getModelClassName |
| Constructor Detail |
|---|
public UserImpl()
| Method Detail |
|---|
public void addRemotePreference(com.liferay.portal.kernel.util.RemotePreference remotePreference)
public com.liferay.portal.kernel.model.Contact fetchContact()
public List<com.liferay.portal.kernel.model.Address> getAddresses()
public Date getBirthday()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public String getCompanyMx()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public com.liferay.portal.kernel.model.Contact getContact()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionContactpublic String getDigest()
getDigest in interface com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.exception.PortalException
getDisplayURL(ThemeDisplay)
The logic for the display URL to return is as follows:
portalURL - the portal's URLmainPath - the main path
com.liferay.portal.kernel.exception.PortalException
@Deprecated
public String getDisplayURL(String portalURL,
String mainPath,
boolean privateLayout)
throws com.liferay.portal.kernel.exception.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
com.liferay.portal.kernel.exception.PortalException
public String getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
throws com.liferay.portal.kernel.exception.PortalException
The logic for the display URL to return is as follows:
themeDisplay - the theme display
com.liferay.portal.kernel.exception.PortalException
public String getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
boolean privateLayout)
throws com.liferay.portal.kernel.exception.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
com.liferay.portal.kernel.exception.PortalExceptionpublic List<com.liferay.portal.kernel.model.EmailAddress> getEmailAddresses()
public boolean getFemale()
throws com.liferay.portal.kernel.exception.PortalException
true if the user is female.
true if the user is female; false
otherwise
com.liferay.portal.kernel.exception.PortalException@AutoEscape public String getFullName()
@AutoEscape
public String getFullName(boolean usePrefix,
boolean useSuffix)
public com.liferay.portal.kernel.model.Group getGroup()
public long getGroupId()
public long[] getGroupIds()
public List<com.liferay.portal.kernel.model.Group> getGroups()
public String getInitials()
public Locale getLocale()
public String getLogin()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public boolean getMale()
throws com.liferay.portal.kernel.exception.PortalException
true if the user is male.
true if the user is male; false
otherwise
com.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Group> getMySiteGroups()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Group> getMySiteGroups(int max)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Group> getMySiteGroups(String[] classNames,
int max)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public long[] getOrganizationIds()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public long[] getOrganizationIds(boolean includeAdministrative)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Organization> getOrganizations()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Organization> getOrganizations(boolean includeAdministrative)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic String getOriginalEmailAddress()
getOriginalEmailAddress in interface com.liferay.portal.kernel.model.UsergetOriginalEmailAddress in class UserModelImplpublic boolean getPasswordModified()
public com.liferay.portal.kernel.model.PasswordPolicy getPasswordPolicy()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic String getPasswordUnencrypted()
public List<com.liferay.portal.kernel.model.Phone> getPhones()
public String getPortraitURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public int getPrivateLayoutsPageCount()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public int getPublicLayoutsPageCount()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public Set<String> getReminderQueryQuestions()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic com.liferay.portal.kernel.util.RemotePreference getRemotePreference(String name)
public Iterable<com.liferay.portal.kernel.util.RemotePreference> getRemotePreferences()
public long[] getRoleIds()
public List<com.liferay.portal.kernel.model.Role> getRoles()
public List<com.liferay.portal.kernel.model.Group> getSiteGroups()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Group> getSiteGroups(boolean includeAdministrative)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic long[] getTeamIds()
public List<com.liferay.portal.kernel.model.Team> getTeams()
public TimeZone getTimeZone()
public Date getUnlockDate()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic Date getUnlockDate(com.liferay.portal.kernel.model.PasswordPolicy passwordPolicy)
public long[] getUserGroupIds()
public List<com.liferay.portal.kernel.model.UserGroup> getUserGroups()
public List<com.liferay.portal.kernel.model.Website> getWebsites()
public boolean hasCompanyMx()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public boolean hasCompanyMx(String emailAddress)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public boolean hasMySites()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic boolean hasOrganization()
public boolean hasPrivateLayouts()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public boolean hasPublicLayouts()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic boolean hasReminderQuery()
public boolean isActive()
public boolean isEmailAddressComplete()
public boolean isEmailAddressVerificationComplete()
public boolean isFemale()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public boolean isMale()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic boolean isPasswordModified()
public boolean isReminderQueryComplete()
public boolean isSetupComplete()
public boolean isTermsOfUseComplete()
public void setLanguageId(String languageId)
setLanguageId in interface com.liferay.portal.kernel.model.UserModelsetLanguageId in class UserModelImplpublic void setPasswordModified(boolean passwordModified)
public void setPasswordUnencrypted(String passwordUnencrypted)
public void setTimeZoneId(String timeZoneId)
setTimeZoneId in interface com.liferay.portal.kernel.model.UserModelsetTimeZoneId in class UserModelImplprotected String getProfileFriendlyURL()
|
Liferay 7.0-ce-b8 portal-impl | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||