Liferay 6.2-ce-ga4

com.liferay.portal.model
Interface User

All Superinterfaces:
BaseModel<User>, ClassedModel, Cloneable, Comparable<User>, PersistedModel, 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.

See Also:
UserModel, UserImpl, UserModelImpl

Method Summary
 void addRemotePreference(RemotePreference remotePreference)
           
 List<Address> getAddresses()
           
 Date getBirthday()
           
 String getCompanyMx()
           
 Contact getContact()
           
 String getDigest(String password)
           
 String getDisplayEmailAddress()
           
 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.
 Group getGroup()
           
 long getGroupId()
           
 long[] getGroupIds()
           
 List<Group> getGroups()
           
 Locale getLocale()
           
 String getLogin()
           
 boolean getMale()
          Returns true if the user is male.
 List<Group> getMySiteGroups()
           
 List<Group> getMySiteGroups(boolean includeControlPanel, int max)
           
 List<Group> getMySiteGroups(int max)
           
 List<Group> getMySiteGroups(String[] classNames, boolean includeControlPanel, int max)
           
 List<Group> getMySiteGroups(String[] classNames, int max)
           
 List<Group> getMySites()
          Deprecated. As of 6.2.0, replaced by getMySiteGroups()
 List<Group> getMySites(boolean includeControlPanel, int max)
          Deprecated. As of 6.2.0, replaced by getMySiteGroups(boolean, int)
 List<Group> getMySites(int max)
          Deprecated. As of 6.2.0, replaced by getMySiteGroups(int)
 List<Group> getMySites(String[] classNames, boolean includeControlPanel, int max)
          Deprecated. As of 6.2.0, replaced by getMySiteGroups(String[], boolean, int)
 List<Group> getMySites(String[] classNames, int max)
          Deprecated. As of 6.2.0, replaced by getMySiteGroups(String[], int)
 long[] getOrganizationIds()
           
 long[] getOrganizationIds(boolean includeAdministrative)
           
 List<Organization> getOrganizations()
           
 List<Organization> getOrganizations(boolean includeAdministrative)
           
 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()
           
 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.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

List<Address> getAddresses()
                           throws SystemException
Throws:
SystemException

getBirthday

Date getBirthday()
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

getCompanyMx

String getCompanyMx()
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getContact

Contact getContact()
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

getDigest

String getDigest(String password)

getDisplayEmailAddress

String getDisplayEmailAddress()

getDisplayURL

@Deprecated
String getDisplayURL(String portalURL,
                                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
String getDisplayURL(String portalURL,
                                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

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

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

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

List<Group> getGroups()
                      throws SystemException
Throws:
SystemException

getLocale

Locale getLocale()

getLogin

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

List<Group> getMySiteGroups()
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getMySiteGroups

List<Group> getMySiteGroups(boolean includeControlPanel,
                            int max)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getMySiteGroups

List<Group> getMySiteGroups(int max)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getMySiteGroups

List<Group> getMySiteGroups(String[] classNames,
                            boolean includeControlPanel,
                            int max)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getMySiteGroups

List<Group> getMySiteGroups(String[] classNames,
                            int max)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getMySites

List<Group> getMySites()
                       throws PortalException,
                              SystemException
Deprecated. As of 6.2.0, replaced by getMySiteGroups()

Throws:
PortalException
SystemException

getMySites

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

List<Group> getMySites(int max)
                       throws PortalException,
                              SystemException
Deprecated. As of 6.2.0, replaced by getMySiteGroups(int)

Throws:
PortalException
SystemException

getMySites

List<Group> getMySites(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

List<Group> getMySites(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

List<Organization> getOrganizations()
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getOrganizations

List<Organization> getOrganizations(boolean includeAdministrative)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getPasswordModified

boolean getPasswordModified()

getPasswordPolicy

PasswordPolicy getPasswordPolicy()
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getPasswordUnencrypted

String getPasswordUnencrypted()

getPhones

List<Phone> getPhones()
                      throws SystemException
Throws:
SystemException

getPortraitURL

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

Set<String> getReminderQueryQuestions()
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

getRemotePreference

RemotePreference getRemotePreference(String name)

getRemotePreferences

Iterable<RemotePreference> getRemotePreferences()

getRoleIds

long[] getRoleIds()
                  throws SystemException
Throws:
SystemException

getRoles

List<Role> getRoles()
                    throws SystemException
Throws:
SystemException

getSiteGroups

List<Group> getSiteGroups()
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getSiteGroups

List<Group> getSiteGroups(boolean includeAdministrative)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getTeamIds

long[] getTeamIds()
                  throws SystemException
Throws:
SystemException

getTeams

List<Team> getTeams()
                    throws SystemException
Throws:
SystemException

getTimeZone

TimeZone getTimeZone()

getUserGroupIds

long[] getUserGroupIds()
                       throws SystemException
Throws:
SystemException

getUserGroups

List<UserGroup> getUserGroups()
                              throws SystemException
Throws:
SystemException

getWebsites

List<Website> getWebsites()
                          throws SystemException
Throws:
SystemException

hasCompanyMx

boolean hasCompanyMx()
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

hasCompanyMx

boolean hasCompanyMx(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(String passwordUnencrypted)

Liferay 6.2-ce-ga4