com.liferay.portal.model
Interface User

All Superinterfaces:

BaseModel<User>, ClassedModel, Cloneable, Comparable<User>, PersistedModel, Serializable, UserModel

All Known Implementing Classes:

UserBaseImpl, UserImpl, UserWrapper

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.

Method Summary

List<Address>	getAddresses()
Date	getBirthday()
String	getCompanyMx()
Contact	getContact()
String	getDigest() Returns the digest of this user.
String	getDigest(String password)
String	getDisplayEmailAddress()
String	getDisplayURL(String portalURL, String mainPath)
String	getDisplayURL(String portalURL, String mainPath, boolean privateLayout)
String	getDisplayURL(ThemeDisplay themeDisplay)
String	getDisplayURL(ThemeDisplay themeDisplay, boolean privateLayout)
List<EmailAddress>	getEmailAddresses()
boolean	getFemale()
String	getFullName()
Group	getGroup()
long	getGroupId()
long[]	getGroupIds()
List<Group>	getGroups()
Locale	getLocale()
String	getLogin()
boolean	getMale()
List<Group>	getMySites()
List<Group>	getMySites(boolean includeControlPanel, int max)
List<Group>	getMySites(int max)
List<Group>	getMySites(String[] classNames, boolean includeControlPanel, int max)
List<Group>	getMySites(String[] classNames, int max)
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()
long[]	getRoleIds()
List<Role>	getRoles()
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	isFemale()
boolean	isMale()
boolean	isPasswordModified()
void	setLanguageId(String languageId) Sets the language ID of this user.
void	setPasswordModified(boolean passwordModified)
void	setPasswordUnencrypted(String passwordUnencrypted)
void	setTimeZoneId(String timeZoneId) Sets the time zone ID of this user.

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

clone, compareTo, getAgreedToTermsOfUse, getComments, getCompanyId, getContactId, getCreateDate, getDefaultUser, getEmailAddress, getEmailAddressVerified, getExpandoBridge, getFacebookId, getFailedLoginAttempts, getFirstName, getGraceLoginCount, getGreeting, getJobTitle, getLanguageId, getLastFailedLoginDate, getLastLoginDate, getLastLoginIP, getLastName, 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, setFacebookId, setFailedLoginAttempts, setFirstName, setGraceLoginCount, setGreeting, setJobTitle, setLastFailedLoginDate, setLastLoginDate, setLastLoginIP, setLastName, setLockout, setLockoutDate, setLoginDate, setLoginIP, setMiddleName, setModifiedDate, setNew, setOpenId, setPassword, setPasswordEncrypted, setPasswordModifiedDate, setPasswordReset, setPortraitId, setPrimaryKey, setPrimaryKeyObj, setReminderQueryAnswer, setReminderQueryQuestion, setScreenName, setStatus, 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.ClassedModel

getModelClass, getModelClassName

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

persist

Method Detail

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

Description copied from interface: UserModel

Returns the digest of this user.

Specified by:

getDigest in interface UserModel

Returns:

the digest of this user

getDigest

String getDigest(String password)

getDisplayEmailAddress

String getDisplayEmailAddress()

getDisplayURL

String getDisplayURL(String portalURL,
                     String mainPath)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getDisplayURL

String getDisplayURL(String portalURL,
                     String mainPath,
                     boolean privateLayout)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getDisplayURL

String getDisplayURL(ThemeDisplay themeDisplay)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getDisplayURL

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

Throws:

PortalException

SystemException

getEmailAddresses

List<EmailAddress> getEmailAddresses()
                                     throws SystemException

Throws:

SystemException

getFemale

boolean getFemale()
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

getFullName

@AutoEscape
String getFullName()

getGroup

Group getGroup()
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

getGroupId

long getGroupId()
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

getGroupIds

long[] getGroupIds()
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getGroups

List<Group> getGroups()
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getLocale

Locale getLocale()

getLogin

String getLogin()
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

getMale

boolean getMale()
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

getMySites

List<Group> getMySites()
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getMySites

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

Throws:

PortalException

SystemException

getMySites

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

Throws:

PortalException

SystemException

getMySites

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

Throws:

PortalException

SystemException

getMySites

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

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

getRoleIds

long[] getRoleIds()
                  throws SystemException

Throws:

SystemException

getRoles

List<Role> getRoles()
                    throws SystemException

Throws:

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

isFemale

boolean isFemale()
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

isMale

boolean isMale()
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

isPasswordModified

boolean isPasswordModified()

setLanguageId

void setLanguageId(String languageId)

Description copied from interface: UserModel

Sets the language ID of this user.

Specified by:

setLanguageId in interface UserModel

Parameters:

languageId - the language ID of this user

setPasswordModified

void setPasswordModified(boolean passwordModified)

setPasswordUnencrypted

void setPasswordUnencrypted(String passwordUnencrypted)

setTimeZoneId

void setTimeZoneId(String timeZoneId)

Description copied from interface: UserModel

Sets the time zone ID of this user.

Specified by:

setTimeZoneId in interface UserModel

Parameters:

timeZoneId - the time zone ID of this user