Package com.liferay.portal.kernel.model

Interface User

All Superinterfaces:
BaseModel<User>, ClassedModel, Cloneable, Comparable<User>, CTModel<User>, ExternalReferenceCodeModel, MVCCModel, PersistedModel, 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:
Generated:

  • Field Details

  • Method Details

    • fetchContact

      Contact fetchContact()

    • fetchPortraitURL

      String fetchPortraitURL(ThemeDisplay themeDisplay)

    • getAddresses

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

    • getAllGroups

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

    • getAllRoles

      List<Role> getAllRoles() throws PortalException
      Throws:
      PortalException

    • 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:

    • getDigest

      @Deprecated String getDigest(String password)
      Deprecated.
      As of Cavanaugh (7.4.x), with no direct replacement
      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

      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

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

    • getInheritedGroups

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

    • getInheritedRoles

      List<Role> getInheritedRoles() throws PortalException
      Throws:
      PortalException

    • getInheritedSiteGroups

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

    • getInheritedSiteRoles

      List<Role> getInheritedSiteRoles()

    • 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

    • getOrganizations

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

    • getOrganizationsGroups

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

    • getOrganizationsRoles

      List<Role> getOrganizationsRoles() 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

    • 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

    • getSiteRoles

      List<Role> getSiteRoles() 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()

    • getUserGroupRoles

      List<UserGroupRole> getUserGroupRoles() throws PortalException
      Throws:
      PortalException

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

    • isDefaultUser

      @Deprecated boolean isDefaultUser()
      Deprecated.
      As of Cavanaugh (7.4.x), replaced by isGuestUser()

    • isEmailAddressComplete

      boolean isEmailAddressComplete()

    • isEmailAddressVerificationComplete

      boolean isEmailAddressVerificationComplete()

    • isFemale

      boolean isFemale() throws PortalException
      Throws:
      PortalException

    • isGuestUser

      boolean isGuestUser()

    • isLayoutsUpdated

      boolean isLayoutsUpdated()

    • isMale

      boolean isMale() throws PortalException
      Throws:
      PortalException

    • isOnDemandUser

      boolean isOnDemandUser()

    • isPasswordModified

      boolean isPasswordModified()

    • isPasswordResetRequired

      boolean isPasswordResetRequired()

    • isReminderQueryComplete

      boolean isReminderQueryComplete()

    • isServiceAccountUser

      boolean isServiceAccountUser()

    • isSetupComplete

      boolean isSetupComplete()

    • isTermsOfUseComplete

      boolean isTermsOfUseComplete()

    • setContact

      void setContact(Contact contact)

    • setGroup

      void setGroup(Group group)

    • setGroupId

      void setGroupId(long groupId)

    • setGroupIds

      void setGroupIds(long[] groupIds)

    • setLayoutsUpdated

      void setLayoutsUpdated(boolean layoutsUpdated)

    • setOrganizationIds

      void setOrganizationIds(long[] organizationIds)

    • setPasswordModified

      void setPasswordModified(boolean passwordModified)

    • setPasswordUnencrypted

      void setPasswordUnencrypted(String passwordUnencrypted)

    • setRoleIds

      void setRoleIds(long[] roleIds)

    • setTeamIds

      void setTeamIds(long[] teamIds)

    • setUserGroupIds

      void setUserGroupIds(long[] userGroupIds)