com.liferay.portal.kernel.model

Interface User

All Superinterfaces:

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

All Known Implementing Classes:

UserWrapper

@ProviderType
public interface User
extends PersistedModel, UserModel

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

Generated:

Field Summary

Fields

Modifier and Type	Field and Description
static Accessor<User,java.lang.Long>	USER_ID_ACCESSOR

Method Summary

Modifier and Type	Method and Description
void	addRemotePreference(RemotePreference remotePreference)
Contact	fetchContact()
java.lang.String	fetchPortraitURL(ThemeDisplay themeDisplay)
java.util.List<Address>	getAddresses() Returns the user's addresses.
java.util.Date	getBirthday() Returns the user's birth date.
java.lang.String	getCompanyMx() Returns the user's company's mail domain.
Contact	getContact() Returns the user's associated contact.
java.lang.String	getDigest(java.lang.String password) Returns a digest for the user, incorporating the password.
java.lang.String	getDisplayEmailAddress() Returns the user's primary email address, or a blank string if the address is fake.
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.
java.lang.String	getFullName(boolean usePrefix, boolean useSuffix) Returns the user's full name.
Group	getGroup()
long	getGroupId()
long[]	getGroupIds()
java.util.List<Group>	getGroups()
java.lang.String	getInitials()
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(int max)
java.util.List<Group>	getMySiteGroups(java.lang.String[] classNames, int max)
long[]	getOrganizationIds()
long[]	getOrganizationIds(boolean includeAdministrative)
java.util.List<Organization>	getOrganizations()
java.util.List<Organization>	getOrganizations(boolean includeAdministrative)
java.lang.String	getOriginalEmailAddress()
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()
java.util.Date	getUnlockDate()
java.util.Date	getUnlockDate(PasswordPolicy passwordPolicy)
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.kernel.model.PersistedModel

persist

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

getAgreedToTermsOfUse, getComments, getCompanyId, getContactId, getCreateDate, getCtCollectionId, getDefaultUser, getDigest, getEmailAddress, getEmailAddressVerified, getExternalReferenceCode, 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, getReminderQueryAnswer, getReminderQueryQuestion, getScreenName, getStatus, getTimeZoneId, getUserId, getUserUuid, getUuid, isAgreedToTermsOfUse, isDefaultUser, isEmailAddressVerified, isLockout, isPasswordEncrypted, isPasswordReset, setAgreedToTermsOfUse, setComments, setCompanyId, setContactId, setCreateDate, setCtCollectionId, setDefaultUser, setDigest, setEmailAddress, setEmailAddressVerified, setExternalReferenceCode, setFacebookId, setFailedLoginAttempts, setFirstName, setGoogleUserId, setGraceLoginCount, setGreeting, setJobTitle, setLanguageId, setLastFailedLoginDate, setLastLoginDate, setLastLoginIP, setLastName, setLdapServerId, setLockout, setLockoutDate, setLoginDate, setLoginIP, setMiddleName, setModifiedDate, setMvccVersion, setOpenId, setPassword, setPasswordEncrypted, setPasswordModifiedDate, setPasswordReset, setPortraitId, setPrimaryKey, setReminderQueryAnswer, setReminderQueryQuestion, setScreenName, setStatus, setTimeZoneId, setUserId, setUserUuid, setUuid

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

clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

clone, getStagedModelType

Field Detail

USER_ID_ACCESSOR

static final Accessor<User,java.lang.Long> USER_ID_ACCESSOR

Method Detail

addRemotePreference

void addRemotePreference(RemotePreference remotePreference)

fetchContact

Contact fetchContact()

fetchPortraitURL

java.lang.String fetchPortraitURL(ThemeDisplay themeDisplay)

getAddresses

java.util.List<Address> getAddresses()

Returns the user's addresses.

Returns:

the user's addresses

getBirthday

java.util.Date getBirthday()
                    throws PortalException

Returns the user's birth date.

Returns:

the user's birth date

Throws:

PortalException

getCompanyMx

java.lang.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

java.lang.String getDigest(java.lang.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

java.lang.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

java.lang.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

java.lang.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

java.util.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
java.lang.String getFullName()

Returns the user's full name.

Returns:

the user's full name

getFullName

@AutoEscape
java.lang.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

java.util.List<Group> getGroups()

getInitials

java.lang.String getInitials()

getLocale

java.util.Locale getLocale()

getLogin

java.lang.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

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

Throws:

PortalException

getMySiteGroups

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

Throws:

PortalException

getMySiteGroups

java.util.List<Group> getMySiteGroups(java.lang.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

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

Throws:

PortalException

getOrganizations

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

Throws:

PortalException

getOriginalEmailAddress

java.lang.String getOriginalEmailAddress()

getPasswordModified

boolean getPasswordModified()

getPasswordPolicy

PasswordPolicy getPasswordPolicy()
                          throws PortalException

Throws:

PortalException

getPasswordUnencrypted

java.lang.String getPasswordUnencrypted()

getPhones

java.util.List<Phone> getPhones()

getPortraitURL

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

Throws:

PortalException

getPrivateLayoutsPageCount

int getPrivateLayoutsPageCount()
                        throws PortalException

Throws:

PortalException

getPublicLayoutsPageCount

int getPublicLayoutsPageCount()
                       throws PortalException

Throws:

PortalException

getReminderQueryQuestions

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

Throws:

PortalException

getRemotePreference

RemotePreference getRemotePreference(java.lang.String name)

getRemotePreferences

java.lang.Iterable<RemotePreference> getRemotePreferences()

getRoleIds

long[] getRoleIds()

getRoles

java.util.List<Role> getRoles()

getSiteGroups

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

Throws:

PortalException

getSiteGroups

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

Throws:

PortalException

getTeamIds

long[] getTeamIds()

getTeams

java.util.List<Team> getTeams()

getTimeZone

java.util.TimeZone getTimeZone()

getUnlockDate

java.util.Date getUnlockDate()
                      throws PortalException

Throws:

PortalException

getUnlockDate

java.util.Date getUnlockDate(PasswordPolicy passwordPolicy)

getUserGroupIds

long[] getUserGroupIds()

getUserGroups

java.util.List<UserGroup> getUserGroups()

getWebsites

java.util.List<Website> getWebsites()

hasCompanyMx

boolean hasCompanyMx()
              throws PortalException

Throws:

PortalException

hasCompanyMx

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