com.liferay.portal.model
Interface User

All Superinterfaces:

BaseModel<User>, java.lang.Cloneable, java.lang.Comparable<User>, java.io.Serializable, UserModel

All Known Implementing Classes:

UserWrapper

public interface User
extends UserModel

The model interface for the User service. Represents a row in the "User_" database table, with each column mapped to a property of this class.

Never modify this interface directly. Add methods to UserImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Never reference this interface directly. All methods that expect a user model instance should use the User interface instead.

Author:

Brian Wing Shun Chan

See Also:

UserModel, UserImpl, UserModelImpl

Generated:

Method Summary

java.util.Date	getBirthday()
java.lang.String	getCompanyMx()
Contact	getContact()
java.lang.String	getDigest() Gets 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)
boolean	getFemale()
java.lang.String	getFullName()
Group	getGroup()
long[]	getGroupIds()
java.util.List<Group>	getGroups()
java.util.Locale	getLocale()
java.lang.String	getLogin()
boolean	getMale()
java.util.List<Group>	getMyPlaces()
java.util.List<Group>	getMyPlaces(int max)
long[]	getOrganizationIds()
java.util.List<Organization>	getOrganizations()
boolean	getPasswordModified()
PasswordPolicy	getPasswordPolicy()
java.lang.String	getPasswordUnencrypted()
int	getPrivateLayoutsPageCount()
int	getPublicLayoutsPageCount()
java.util.Set<java.lang.String>	getReminderQueryQuestions()
long[]	getRoleIds()
java.util.List<Role>	getRoles()
double	getSocialContributionEquity()
double	getSocialParticipationEquity()
double	getSocialPersonalEquity()
long[]	getTeamIds()
java.util.List<Team>	getTeams()
java.util.TimeZone	getTimeZone()
long[]	getUserGroupIds()
java.util.List<UserGroup>	getUserGroups()
boolean	hasCompanyMx()
boolean	hasCompanyMx(java.lang.String emailAddress)
boolean	hasMyPlaces()
boolean	hasOrganization()
boolean	hasPrivateLayouts()
boolean	hasPublicLayouts()
boolean	hasReminderQuery()
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.
void	updateSocialContributionEquity(double value)
void	updateSocialParticipationEquity(double value)

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

clone, compareTo, getActive, getAgreedToTermsOfUse, getComments, getCompanyId, getContactId, getCreateDate, getDefaultUser, getEmailAddress, 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, getTimeZoneId, getUserId, getUserUuid, getUuid, hashCode, isActive, isAgreedToTermsOfUse, isCachedModel, isDefaultUser, isEscapedModel, isLockout, isNew, isPasswordEncrypted, isPasswordReset, setActive, setAgreedToTermsOfUse, setCachedModel, setComments, setCompanyId, setContactId, setCreateDate, setDefaultUser, setDigest, setEmailAddress, setEscapedModel, 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, setReminderQueryAnswer, setReminderQueryQuestion, setScreenName, setUserId, setUserUuid, setUuid, toEscapedModel, toString, toXmlString

Method Detail

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

Gets 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(ThemeDisplay themeDisplay)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getDisplayURL

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

Throws:

PortalException

SystemException

getFemale

boolean getFemale()
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

getFullName

java.lang.String getFullName()

getGroup

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

getMyPlaces

java.util.List<Group> getMyPlaces()
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

getMyPlaces

java.util.List<Group> getMyPlaces(int max)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

getOrganizationIds

long[] getOrganizationIds()
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getOrganizations

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

Throws:

PortalException

SystemException

getPasswordModified

boolean getPasswordModified()

getPasswordPolicy

PasswordPolicy getPasswordPolicy()
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getPasswordUnencrypted

java.lang.String getPasswordUnencrypted()

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

getSocialContributionEquity

double getSocialContributionEquity()

getSocialParticipationEquity

double getSocialParticipationEquity()

getSocialPersonalEquity

double getSocialPersonalEquity()

getTeamIds

long[] getTeamIds()
                  throws SystemException

Throws:

SystemException

getTeams

java.util.List<Team> getTeams()
                              throws SystemException

Throws:

SystemException

getUserGroupIds

long[] getUserGroupIds()
                       throws SystemException

Throws:

SystemException

getUserGroups

java.util.List<UserGroup> getUserGroups()
                                        throws SystemException

Throws:

SystemException

getTimeZone

java.util.TimeZone getTimeZone()

hasCompanyMx

boolean hasCompanyMx()
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

hasCompanyMx

boolean hasCompanyMx(java.lang.String emailAddress)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

hasMyPlaces

boolean hasMyPlaces()
                    throws SystemException

Throws:

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

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

updateSocialContributionEquity

void updateSocialContributionEquity(double value)

updateSocialParticipationEquity

void updateSocialParticipationEquity(double value)