com.liferay.portal.model

Interface User

All Superinterfaces:

BaseModel<User>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<User>, PersistedModel, java.io.Serializable, StagedModel, UserModel

All Known Implementing Classes:

UserWrapper

@ProviderType
public interface User
extends UserModel, PersistedModel

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.

Author:

Brian Wing Shun Chan

See Also:

UserModel, UserImpl, UserModelImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
void	addRemotePreference(RemotePreference remotePreference)
java.util.List<Address>	getAddresses()
java.util.Date	getBirthday()
java.lang.String	getCompanyMx()
Contact	getContact()
java.lang.String	getDigest(java.lang.String password)
java.lang.String	getDisplayEmailAddress()
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.
Group	getGroup()
long	getGroupId()
long[]	getGroupIds()
java.util.List<Group>	getGroups()
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(boolean includeControlPanel, int max)
java.util.List<Group>	getMySiteGroups(int max)
java.util.List<Group>	getMySiteGroups(java.lang.String[] classNames, boolean includeControlPanel, 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(boolean, 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[], boolean, 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)
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()
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)

Methods inherited from interface com.liferay.portal.model.UserModel

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, 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, setNew, setOpenId, setPassword, setPasswordEncrypted, setPasswordModifiedDate, setPasswordReset, setPortraitId, setPrimaryKey, setPrimaryKeyObj, setReminderQueryAnswer, setReminderQueryQuestion, setScreenName, setStatus, setTimeZoneId, setUserId, setUserUuid, setUuid, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString

Methods inherited from interface com.liferay.portal.model.BaseModel

getModelAttributes, 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

Method Detail

addRemotePreference

void addRemotePreference(RemotePreference remotePreference)

getAddresses

java.util.List<Address> getAddresses()
                                     throws SystemException

Throws:

SystemException

getBirthday

java.util.Date getBirthday()
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getCompanyMx

java.lang.String getCompanyMx()
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getContact

Contact getContact()
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getDigest

java.lang.String getDigest(java.lang.String password)

getDisplayEmailAddress

java.lang.String getDisplayEmailAddress()

getDisplayURL

@Deprecated
java.lang.String getDisplayURL(java.lang.String portalURL,
                                        java.lang.String mainPath)
                               throws PortalException,
                                      SystemException

Deprecated. As of 7.0.0, replaced by getDisplayURL(ThemeDisplay)

Returns the user's display URL, discounting the URL of the user's default intranet site home page.

The logic for the display URL to return is as follows:

1. If the user is the guest user, return an empty string.
2. Else, if a friendly URL is available for the user's profile, return that friendly URL.
3. Otherwise, return the URL of the user's default extranet site home page.

Parameters:

portalURL - the portal's URL

mainPath - the main path

Returns:

the user's display URL

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getDisplayURL

@Deprecated
java.lang.String getDisplayURL(java.lang.String portalURL,
                                        java.lang.String mainPath,
                                        boolean privateLayout)
                               throws PortalException,
                                      SystemException

Deprecated. As of 7.0.0, replaced by getDisplayURL(ThemeDisplay)

Returns the user's display URL.

The logic for the display URL to return is as follows:

1. If the user is the guest user, return an empty string.
2. Else, if a friendly URL is available for the user's profile, return that friendly URL.
3. Else, if privateLayout is true, return the URL of the user's default intranet site home page.
4. Otherwise, return the URL of the user's default extranet site home page.

Parameters:

portalURL - the portal's URL

mainPath - the main path

privateLayout - 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

Returns:

the user's display URL

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getDisplayURL

java.lang.String getDisplayURL(ThemeDisplay themeDisplay)
                               throws PortalException,
                                      SystemException

Returns the user's display URL based on the theme display, discounting the URL of the user's default intranet site home page.

The logic for the display URL to return is as follows:

1. If the user is the guest user, return an empty string.
2. Else, if a friendly URL is available for the user's profile, return that friendly URL.
3. Otherwise, return the URL of the user's default extranet site home page.

Parameters:

themeDisplay - the theme display

Returns:

the user's display URL

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getDisplayURL

java.lang.String getDisplayURL(ThemeDisplay themeDisplay,
                             boolean privateLayout)
                               throws PortalException,
                                      SystemException

Returns the user's display URL based on the theme display.

The logic for the display URL to return is as follows:

1. If the user is the guest user, return an empty string.
2. Else, if a friendly URL is available for the user's profile, return that friendly URL.
3. Else, if privateLayout is true, return the URL of the user's default intranet site home page.
4. Otherwise, return the URL of the user's default extranet site home page.

Parameters:

themeDisplay - the theme display

privateLayout - 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

Returns:

the user's display URL

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getEmailAddresses

java.util.List<EmailAddress> getEmailAddresses()
                                               throws SystemException

Returns the user's email addresses.

Returns:

the user's email addresses

Throws:

SystemException - if a system exception occurred

getFemale

boolean getFemale()
                  throws PortalException,
                         SystemException

Returns true if the user is female.

Returns:

true if the user is female; false otherwise

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getFullName

@AutoEscape
java.lang.String getFullName()

Returns the user's full name.

Returns:

the user's full name

getGroup

Group getGroup()
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

getGroupId

long getGroupId()
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

getGroupIds

long[] getGroupIds()
                   throws SystemException

Throws:

SystemException

getGroups

java.util.List<Group> getGroups()
                                throws SystemException

Throws:

SystemException

getLocale

java.util.Locale getLocale()

getLogin

java.lang.String getLogin()
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getMale

boolean getMale()
                throws PortalException,
                       SystemException

Returns true if the user is male.

Returns:

true if the user is male; false otherwise

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getMySiteGroups

java.util.List<Group> getMySiteGroups()
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getMySiteGroups

java.util.List<Group> getMySiteGroups(boolean includeControlPanel,
                                    int max)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getMySiteGroups

java.util.List<Group> getMySiteGroups(int max)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getMySiteGroups

java.util.List<Group> getMySiteGroups(java.lang.String[] classNames,
                                    boolean includeControlPanel,
                                    int max)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getMySiteGroups

java.util.List<Group> getMySiteGroups(java.lang.String[] classNames,
                                    int max)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getMySites

java.util.List<Group> getMySites()
                                 throws PortalException,
                                        SystemException

Deprecated. As of 6.2.0, replaced by getMySiteGroups()

Throws:

PortalException

SystemException

getMySites

java.util.List<Group> getMySites(boolean includeControlPanel,
                               int max)
                                 throws PortalException,
                                        SystemException

Deprecated. As of 6.2.0, replaced by getMySiteGroups(boolean, int)

Throws:

PortalException

SystemException

getMySites

java.util.List<Group> getMySites(int max)
                                 throws PortalException,
                                        SystemException

Deprecated. As of 6.2.0, replaced by getMySiteGroups(int)

Throws:

PortalException

SystemException

getMySites

java.util.List<Group> getMySites(java.lang.String[] classNames,
                               boolean includeControlPanel,
                               int max)
                                 throws PortalException,
                                        SystemException

Deprecated. As of 6.2.0, replaced by getMySiteGroups(String[], boolean, int)

Throws:

PortalException

SystemException

getMySites

java.util.List<Group> getMySites(java.lang.String[] classNames,
                               int max)
                                 throws PortalException,
                                        SystemException

Deprecated. As of 6.2.0, replaced by getMySiteGroups(String[], int)

Throws:

PortalException

SystemException

getOrganizationIds

long[] getOrganizationIds()
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getOrganizationIds

long[] getOrganizationIds(boolean includeAdministrative)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getOrganizations

java.util.List<Organization> getOrganizations()
                                              throws PortalException,
                                                     SystemException

Throws:

PortalException

SystemException

getOrganizations

java.util.List<Organization> getOrganizations(boolean includeAdministrative)
                                              throws PortalException,
                                                     SystemException

Throws:

PortalException

SystemException

getPasswordModified

boolean getPasswordModified()

getPasswordPolicy

PasswordPolicy getPasswordPolicy()
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getPasswordUnencrypted

java.lang.String getPasswordUnencrypted()

getPhones

java.util.List<Phone> getPhones()
                                throws SystemException

Throws:

SystemException

getPortraitURL

java.lang.String getPortraitURL(ThemeDisplay themeDisplay)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getPrivateLayoutsPageCount

int getPrivateLayoutsPageCount()
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getPublicLayoutsPageCount

int getPublicLayoutsPageCount()
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getReminderQueryQuestions

java.util.Set<java.lang.String> getReminderQueryQuestions()
                                                          throws PortalException,
                                                                 SystemException

Throws:

PortalException

SystemException

getRemotePreference

RemotePreference getRemotePreference(java.lang.String name)

getRemotePreferences

java.lang.Iterable<RemotePreference> getRemotePreferences()

getRoleIds

long[] getRoleIds()
                  throws SystemException

Throws:

SystemException

getRoles

java.util.List<Role> getRoles()
                              throws SystemException

Throws:

SystemException

getSiteGroups

java.util.List<Group> getSiteGroups()
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getSiteGroups

java.util.List<Group> getSiteGroups(boolean includeAdministrative)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getTeamIds

long[] getTeamIds()
                  throws SystemException

Throws:

SystemException

getTeams

java.util.List<Team> getTeams()
                              throws SystemException

Throws:

SystemException

getTimeZone

java.util.TimeZone getTimeZone()

getUserGroupIds

long[] getUserGroupIds()
                       throws SystemException

Throws:

SystemException

getUserGroups

java.util.List<UserGroup> getUserGroups()
                                        throws SystemException

Throws:

SystemException

getWebsites

java.util.List<Website> getWebsites()
                                    throws SystemException

Throws:

SystemException

hasCompanyMx

boolean hasCompanyMx()
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

hasCompanyMx

boolean hasCompanyMx(java.lang.String emailAddress)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

hasMySites

boolean hasMySites()
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

hasOrganization

boolean hasOrganization()
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

hasPrivateLayouts

boolean hasPrivateLayouts()
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

hasPublicLayouts

boolean hasPublicLayouts()
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

hasReminderQuery

boolean hasReminderQuery()

isActive

boolean isActive()

isEmailAddressComplete

boolean isEmailAddressComplete()

isEmailAddressVerificationComplete

boolean isEmailAddressVerificationComplete()

isFemale

boolean isFemale()
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

isMale

boolean isMale()
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

isPasswordModified

boolean isPasswordModified()

isReminderQueryComplete

boolean isReminderQueryComplete()

isSetupComplete

boolean isSetupComplete()

isTermsOfUseComplete

boolean isTermsOfUseComplete()

setPasswordModified

void setPasswordModified(boolean passwordModified)

setPasswordUnencrypted

void setPasswordUnencrypted(java.lang.String passwordUnencrypted)