Class User

All Implemented Interfaces:
Identifiable, Principal, Serializable

public class User extends UserDescriptor
Full representation of a user account thats defined in the system. A user account has a unique user ID that can be used to login and to identify a user account in the system.
Since:
1.2
See Also:
  • Constructor Details

    • User

      public User(String id, String userId, String displayName, String firstName, String lastName, String department, String phone, String email, List<Attribute> attributes, AccountInfo accountInfo, PasswordInfo passwordInfo, LockedInfo lockedInfo, LoginInfo loginInfo, long revision)
      It is not intended or recommended that the consumer of this API construct these objects. They should only deal with the users returned by the API.
      Parameters:
      id - the unique identifier of the user account.
      userId - the user ID of the user account.
      displayName - the display name of the user account.
      firstName - the first name for the user account.
      lastName - the last name for the user account.
      department - the department value for the user account.
      phone - the phone number for the user account.
      email - the email for the user account.
      attributes - the list of extended attribute values for the user account.
      accountInfo - the account details for the user account.
      passwordInfo - the password details for the user account.
      lockedInfo - the account locking details for the user account.
      loginInfo - the login details for the user account.
      revision - the internal revision number of this object.
    • User

      public User(String id, String userId, String displayName, String createdBy, Date created, String lastModifiedBy, Date lastModified, String firstName, String lastName, String department, String phone, String email, List<Attribute> attributes, AccountInfo accountInfo, PasswordInfo passwordInfo, LockedInfo lockedInfo, LoginInfo loginInfo, long revision)
      It is not intended or recommended that the consumer of this API construct these objects. They should only deal with the users returned by the API.
      Parameters:
      id - the unique identifier of the user account.
      userId - the user ID of the user account.
      displayName - the display name of the user account.
      createdBy - The user who created the user.
      created - The date on which the user was created.
      lastModifiedBy - The user who last modified the user.
      lastModified - The date on which the user was last modified.
      firstName - the first name for the user account.
      lastName - the last name for the user account.
      department - the department value for the user account.
      phone - the phone number for the user account.
      email - the email for the user account.
      attributes - the list of extended attribute values for the user account.
      accountInfo - the account details for the user account.
      passwordInfo - the password details for the user account.
      lockedInfo - the account locking details for the user account.
      loginInfo - the login details for the user account.
      revision - the internal revision number of this object.
  • Method Details

    • getRevision

      public long getRevision()
      Gets the internal revision number of an object.
      Returns:
      The internal revision number of an object.
    • getAccountInfo

      public AccountInfo getAccountInfo()
      Gets the account details for a user account.
      Returns:
      The account details for a user account.
    • getPasswordInfo

      public PasswordInfo getPasswordInfo()
      Gets the password details for a user account.
      Returns:
      The password details for a user account.
    • getLockedInfo

      public LockedInfo getLockedInfo()
      Gets the account locking details for a user account.
      Returns:
      The account locking details for a user account.
    • getLoginInfo

      public LoginInfo getLoginInfo()
      Gets the login details for a user account.
      Returns:
      The login details for a user account.
    • getFirstName

      public String getFirstName()
      Gets the first name for a user account.
      Returns:
      The first name for a user account.
    • setFirstName

      public void setFirstName(String firstName)
      Sets the first name for a user account.
      Parameters:
      firstName - the firstName to set for a user account.
    • getLastName

      public String getLastName()
      Gets the last name for a user account.
      Returns:
      The last name for a user account.
    • setLastName

      public void setLastName(String lastName)
      Sets the last name for a user account.
      Parameters:
      lastName - the lastName to set for a user account.
    • getEmail

      public String getEmail()
      Gets the email for a user account.
      Returns:
      The email for a user account.
    • setEmail

      public void setEmail(String email)
      Sets the email address value for a user account.
      Parameters:
      email - the email address for a user account.
    • getDepartment

      public String getDepartment()
      Gets the department value for a user account.
      Returns:
      The department value for a user account.
    • setDepartment

      public void setDepartment(String department)
      Sets the department value for a user account.
      Parameters:
      department - the department to set for a user account.
    • getPhone

      public String getPhone()
      Gets the phone number for a user account.
      Returns:
      The phone number for a user account.
    • setPhone

      public void setPhone(String phone)
      Sets the phone number for a user account.
      Parameters:
      phone - the phone number to set for a user account.
    • getAttributes

      public List<Attribute> getAttributes()
      Gets the list of extended attributes defined for a user account.
      Returns:
      The extended attributes for a user account.
    • setAttributes

      public void setAttributes(List<Attribute> attributes)
      Sets the extended attribute values for a user account.
      Parameters:
      attributes - the list of extended attribute values for a user account.
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface Principal
      Overrides:
      hashCode in class UserDescriptor
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface Principal
      Overrides:
      equals in class UserDescriptor
    • toString

      public String toString()
      Overrides:
      toString in class UserDescriptor