Liferay 7.0-ce-b4

com.liferay.portal.model
Interface User

All Superinterfaces:
BaseModel<User>, ClassedModel, Cloneable, Comparable<User>, MVCCModel, PersistedModel, Serializable, ShardedModel, StagedModel, UserModel
All Known Implementing Classes:
UserBaseImpl, UserImpl, 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
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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.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, 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, setGraceLoginCount, setGreeting, setJobTitle, setLanguageId, 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, setTimeZoneId, setUserId, setUserUuid, setUuid, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString
 
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

USER_ID_ACCESSOR

static final Accessor<User,Long> USER_ID_ACCESSOR
Method Detail

addRemotePreference

void addRemotePreference(RemotePreference remotePreference)

fetchContact

Contact fetchContact()

getAddresses

List<Address> getAddresses()
Returns the user's addresses.

Returns:
the user's addresses

getBirthday

Date getBirthday()
                 throws PortalException
Returns the user's birth date.

Returns:
the user's birth date
Throws:
PortalException

getCompanyMx

String getCompanyMx()
                    throws PortalException
Returns the user's company's mail domain.

Returns:
the user's company's mail domain
Throws:
PortalException

getContact

Contact getContact()
                   throws PortalException
Returns the user's associated contact.

Returns:
the user's associated contact
Throws:
PortalException
See Also:
Contact

getDigest

String getDigest(String password)
Returns a digest for the user, incorporating the password.

Parameters:
password - a password to incorporate with the digest
Returns:
a digest for the user, incorporating the password

getDisplayEmailAddress

String getDisplayEmailAddress()
Returns the user's primary email address, or a blank string if the address is fake.

Returns:
the user's primary email address, or a blank string if the address is fake

getDisplayURL

@Deprecated
String getDisplayURL(String portalURL,
                                String mainPath)
                     throws PortalException
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

getDisplayURL

@Deprecated
String getDisplayURL(String portalURL,
                                String mainPath,
                                boolean privateLayout)
                     throws PortalException
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

getDisplayURL

String getDisplayURL(ThemeDisplay themeDisplay)
                     throws PortalException
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

getDisplayURL

String getDisplayURL(ThemeDisplay themeDisplay,
                     boolean privateLayout)
                     throws PortalException
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

getEmailAddresses

List<EmailAddress> getEmailAddresses()
Returns the user's email addresses.

Returns:
the user's email addresses

getFemale

boolean getFemale()
                  throws PortalException
Returns true if the user is female.

Returns:
true if the user is female; false otherwise
Throws:
PortalException

getFullName

@AutoEscape
String getFullName()
Returns the user's full name.

Returns:
the user's full name

getFullName

@AutoEscape
String getFullName(boolean usePrefix,
                              boolean useSuffix)
Returns the user's full name.

Returns:
the user's full name

getGroup

Group getGroup()

getGroupId

long getGroupId()

getGroupIds

long[] getGroupIds()

getGroups

List<Group> getGroups()

getInitials

String getInitials()

getLocale

Locale getLocale()

getLogin

String getLogin()
                throws PortalException
Throws:
PortalException

getMale

boolean getMale()
                throws PortalException
Returns true if the user is male.

Returns:
true if the user is male; false otherwise
Throws:
PortalException

getMySiteGroups

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

getMySiteGroups

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

getMySiteGroups

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

getOrganizationIds

long[] getOrganizationIds()
                          throws PortalException
Throws:
PortalException

getOrganizationIds

long[] getOrganizationIds(boolean includeAdministrative)
                          throws PortalException
Throws:
PortalException

getOrganizations

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

getOrganizations

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

getOriginalEmailAddress

String getOriginalEmailAddress()

getPasswordModified

boolean getPasswordModified()

getPasswordPolicy

PasswordPolicy getPasswordPolicy()
                                 throws PortalException
Throws:
PortalException

getPasswordUnencrypted

String getPasswordUnencrypted()

getPhones

List<Phone> getPhones()

getPortraitURL

String getPortraitURL(ThemeDisplay themeDisplay)
                      throws PortalException
Throws:
PortalException

getPrivateLayoutsPageCount

int getPrivateLayoutsPageCount()
                               throws PortalException
Throws:
PortalException

getPublicLayoutsPageCount

int getPublicLayoutsPageCount()
                              throws PortalException
Throws:
PortalException

getReminderQueryQuestions

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

getRemotePreference

RemotePreference getRemotePreference(String name)

getRemotePreferences

Iterable<RemotePreference> getRemotePreferences()

getRoleIds

long[] getRoleIds()

getRoles

List<Role> getRoles()

getSiteGroups

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

getSiteGroups

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

getTeamIds

long[] getTeamIds()

getTeams

List<Team> getTeams()

getTimeZone

TimeZone getTimeZone()

getUnlockDate

Date getUnlockDate()
                   throws PortalException
Throws:
PortalException

getUnlockDate

Date getUnlockDate(PasswordPolicy passwordPolicy)

getUserGroupIds

long[] getUserGroupIds()

getUserGroups

List<UserGroup> getUserGroups()

getWebsites

List<Website> getWebsites()

hasCompanyMx

boolean hasCompanyMx()
                     throws PortalException
Throws:
PortalException

hasCompanyMx

boolean hasCompanyMx(String emailAddress)
                     throws PortalException
Throws:
PortalException

hasMySites

boolean hasMySites()
                   throws PortalException
Throws:
PortalException

hasOrganization

boolean hasOrganization()

hasPrivateLayouts

boolean hasPrivateLayouts()
                          throws PortalException
Throws:
PortalException

hasPublicLayouts

boolean hasPublicLayouts()
                         throws PortalException
Throws:
PortalException

hasReminderQuery

boolean hasReminderQuery()

isActive

boolean isActive()

isEmailAddressComplete

boolean isEmailAddressComplete()

isEmailAddressVerificationComplete

boolean isEmailAddressVerificationComplete()

isFemale

boolean isFemale()
                 throws PortalException
Throws:
PortalException

isMale

boolean isMale()
               throws PortalException
Throws:
PortalException

isPasswordModified

boolean isPasswordModified()

isReminderQueryComplete

boolean isReminderQueryComplete()

isSetupComplete

boolean isSetupComplete()

isTermsOfUseComplete

boolean isTermsOfUseComplete()

setPasswordModified

void setPasswordModified(boolean passwordModified)

setPasswordUnencrypted

void setPasswordUnencrypted(String passwordUnencrypted)

Liferay 7.0-ce-b4