|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType public interface User
The extended model interface for the User service. Represents a row in the "User_" database table, with each column mapped to a property of this class.
UserModel,
UserImpl,
UserModelImpl| Field Summary | |
|---|---|
static Accessor<User,Long> |
USER_ID_ACCESSOR
|
| 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(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()
|
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)
|
| 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 |
| Methods inherited from interface com.liferay.portal.model.PersistedModel |
|---|
persist |
| Field Detail |
|---|
static final Accessor<User,Long> USER_ID_ACCESSOR
| Method Detail |
|---|
void addRemotePreference(RemotePreference remotePreference)
Contact fetchContact()
List<Address> getAddresses()
Date getBirthday()
throws PortalException
PortalException
String getCompanyMx()
throws PortalException
PortalException
Contact getContact()
throws PortalException
PortalExceptionContactString getDigest(String password)
password - a password to incorporate with the digest
String getDisplayEmailAddress()
@Deprecated
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
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
String getDisplayURL(ThemeDisplay themeDisplay)
throws PortalException
The logic for the display URL to return is as follows:
themeDisplay - the theme display
PortalException
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
PortalExceptionList<EmailAddress> getEmailAddresses()
boolean getFemale()
throws PortalException
true if the user is female.
true if the user is female; false
otherwise
PortalException@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
otherwise
PortalException
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
PortalExceptionString getOriginalEmailAddress()
boolean getPasswordModified()
PasswordPolicy getPasswordPolicy()
throws PortalException
PortalExceptionString 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
PortalExceptionRemotePreference getRemotePreference(String name)
Iterable<RemotePreference> getRemotePreferences()
long[] getRoleIds()
List<Role> getRoles()
List<Group> getSiteGroups()
throws PortalException
PortalException
List<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
PortalException
boolean hasCompanyMx(String emailAddress)
throws PortalException
PortalException
boolean hasMySites()
throws PortalException
PortalExceptionboolean hasOrganization()
boolean hasPrivateLayouts()
throws PortalException
PortalException
boolean hasPublicLayouts()
throws PortalException
PortalExceptionboolean hasReminderQuery()
boolean isActive()
boolean isEmailAddressComplete()
boolean isEmailAddressVerificationComplete()
boolean isFemale()
throws PortalException
PortalException
boolean isMale()
throws PortalException
PortalExceptionboolean isPasswordModified()
boolean isReminderQueryComplete()
boolean isSetupComplete()
boolean isTermsOfUseComplete()
void setPasswordModified(boolean passwordModified)
void setPasswordUnencrypted(String passwordUnencrypted)
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||