com.liferay.portal.model
Interface User

All Superinterfaces:
BaseModel<User>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<User>, PersistedModel, java.io.Serializable, UserModel
All Known Implementing Classes:
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.

Author:
Brian Wing Shun Chan
See Also:
UserModel, UserImpl, UserModelImpl
Generated:

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

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()
Description copied from interface: UserModel
Returns the digest of this user.

Specified by:
getDigest in interface UserModel
Returns:
the digest of this user

getDigest

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

getDisplayEmailAddress

java.lang.String getDisplayEmailAddress()

getDisplayURL

java.lang.String getDisplayURL(java.lang.String portalURL,
                               java.lang.String mainPath)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

getDisplayURL

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

getEmailAddresses

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

getFemale

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

getFullName

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

java.util.List<Group> getGroups()
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

getLocale

java.util.Locale getLocale()

getLogin

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

getMale

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

getMySites

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

getMySites

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

getMySites

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

getMySites

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

getMySites

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

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

getRoleIds

long[] getRoleIds()
                  throws SystemException
Throws:
SystemException

getRoles

java.util.List<Role> getRoles()
                              throws SystemException
Throws:
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()

isFemale

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

isMale

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

isPasswordModified

boolean isPasswordModified()

setLanguageId

void setLanguageId(java.lang.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(java.lang.String passwordUnencrypted)

setTimeZoneId

void setTimeZoneId(java.lang.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