```
public class User
extends Object
```
Provide a User value object class.

Since:

5.0.0

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`STATUS_ACTIVE`	The "Active" user status.
`static String`	`STATUS_INACTIVE`	The "Inactive" user status.
`static String`	`STATUS_LOCKED`	The "Locked" user status.
`static String`	`STATUS_LOCKED_TEMPORARILY`	The "Locked Temporarily" user status.
`static String`	`STATUS_PENDING`	The "Pending" user status.
`static String`	`STATUS_REJECTED`	The "Rejected" user status.
`static String`	`TYPE_LDAP`	The "LDAP" user type.
`static String`	`TYPE_LOCAL`	The "Local" user type.
`static String`	`TYPE_SSO`	The "SSO" user type.

Constructor Summary

Constructors
Constructor	Description
`User()`
`User(UserAccount userAccount)`	Create a User value object with the given user account entity.
`User(UserAccount userAccount, Set<String> groupNames)`	Create a User value object with the given user account entity and group names.
`User(Map fields)`	Create a unit testing User value object with the given fields.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAccountStatus()`	The user account status [ Active \| Inactive \| Locked \| Locked Temporarily \| Pending \| Rejected ].
`Date`	`getCreatedTime()`	The time the user was created.
`String`	`getEmail()`	The user email address.
`int`	`getFailedLoginAttempts()`	The number of failed login attempts.
`String`	`getFirstName()`	The user first name (given name).
`Set<String>`	`getGroupNames()`	The user group names.
`Long`	`getId()`	The user id (PK).
`Date`	`getLastAccessedTime()`	The time the user last logged in.
`String`	`getLastName()`	The user last name (family name).
`Date`	`getLockoutEndTime()`	The time a temporary lockout should end.
`String`	`getLoginName()`	The user login name.
`String`	`getMobile()`	The user mobile telephone number.
`Set<String>`	`getOrgNames()`	The user organization names.
`Map<String,String>`	`getProfileMap()`	The user profile values map.
`Set<String>`	`getRoleNames()`	The user role names.
`Set<String>`	`getSpaceNames()`	The user form space names.
`String`	`getUserKey()`	The user GUID alternative key.
`String`	`getUserType()`	The user type [ Local \| LDAP \| SSO ].
`boolean`	`isChangePassword()`	The user is forced change password on next login.
`boolean`	`isEmailVerificationRequired()`	The user requires email verification.
`boolean`	`isHasGlobalAccess()`	The user has global client organization access.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - STATUS_ACTIVE
```
public static final String STATUS_ACTIVE
```
    The "Active" user status.
    
    See Also:
    
    Constant Field Values
  - STATUS_INACTIVE
```
public static final String STATUS_INACTIVE
```
    The "Inactive" user status.
    
    See Also:
    
    Constant Field Values
  - STATUS_LOCKED
```
public static final String STATUS_LOCKED
```
    The "Locked" user status.
    
    See Also:
    
    Constant Field Values
  - STATUS_LOCKED_TEMPORARILY
```
public static final String STATUS_LOCKED_TEMPORARILY
```
    The "Locked Temporarily" user status.
    
    See Also:
    
    Constant Field Values
  - STATUS_PENDING
```
public static final String STATUS_PENDING
```
    The "Pending" user status.
    
    See Also:
    
    Constant Field Values
  - STATUS_REJECTED
```
public static final String STATUS_REJECTED
```
    The "Rejected" user status.
    
    See Also:
    
    Constant Field Values
  - TYPE_LOCAL
```
public static final String TYPE_LOCAL
```
    The "Local" user type.
    
    See Also:
    
    Constant Field Values
  - TYPE_LDAP
```
public static final String TYPE_LDAP
```
    The "LDAP" user type.
    
    See Also:
    
    Constant Field Values
  - TYPE_SSO
```
public static final String TYPE_SSO
```
    The "SSO" user type.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - User
```
public User()
```
  - User
```
public User(UserAccount userAccount)
```
    Create a User value object with the given user account entity.
    
    Parameters:
    
    userAccount - the user account entity (required)
  - User
```
public User(UserAccount userAccount,
            Set<String> groupNames)
```
    Create a User value object with the given user account entity and group names.
    
    Parameters:
    
    userAccount - the user account entity (required)
    
    groupNames - the user group names (required)
  - User
```
public User(Map fields)
```
    Create a unit testing User value object with the given fields.
    
    Parameters:
    
    fields - the user entity fields (required)
    
    Since:
    
    5.1.4
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
  - getId
```
public Long getId()
```
    The user id (PK).
  - getLoginName
```
public String getLoginName()
```
    The user login name.
  - getAccountStatus
```
public String getAccountStatus()
```
    The user account status [ Active | Inactive | Locked | Locked Temporarily | Pending | Rejected ].
  - getEmail
```
public String getEmail()
```
    The user email address.
  - getFirstName
```
public String getFirstName()
```
    The user first name (given name).
  - getLastName
```
public String getLastName()
```
    The user last name (family name).
  - getMobile
```
public String getMobile()
```
    The user mobile telephone number.
  - getUserKey
```
public String getUserKey()
```
    The user GUID alternative key.
  - getUserType
```
public String getUserType()
```
    The user type [ Local | LDAP | SSO ].
  - isHasGlobalAccess
```
public boolean isHasGlobalAccess()
```
    The user has global client organization access.
  - getFailedLoginAttempts
```
public int getFailedLoginAttempts()
```
    The number of failed login attempts.
  - getCreatedTime
```
public Date getCreatedTime()
```
    The time the user was created.
  - getLastAccessedTime
```
public Date getLastAccessedTime()
```
    The time the user last logged in.
  - getLockoutEndTime
```
public Date getLockoutEndTime()
```
    The time a temporary lockout should end.
  - getProfileMap
```
public Map<String,String> getProfileMap()
```
    The user profile values map.
  - getGroupNames
```
public Set<String> getGroupNames()
```
    The user group names.
  - getOrgNames
```
public Set<String> getOrgNames()
```
    The user organization names.
  - getRoleNames
```
public Set<String> getRoleNames()
```
    The user role names.
  - getSpaceNames
```
public Set<String> getSpaceNames()
```
    The user form space names.
  - isChangePassword
```
public boolean isChangePassword()
```
    The user is forced change password on next login.
    
    Since:
    
    19.11.3
  - isEmailVerificationRequired
```
public boolean isEmailVerificationRequired()
```
    The user requires email verification.
    
    Since:
    
    19.11.3

Class User

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_ACTIVE

STATUS_INACTIVE

STATUS_LOCKED

STATUS_LOCKED_TEMPORARILY

STATUS_PENDING

STATUS_REJECTED

TYPE_LOCAL

TYPE_LDAP

TYPE_SSO

Constructor Detail

User

User

User

User

Method Detail

toString

getId

getLoginName

getAccountStatus

getEmail

getFirstName

getLastName

getMobile

getUserKey

getUserType

isHasGlobalAccess

getFailedLoginAttempts

getCreatedTime

getLastAccessedTime

getLockoutEndTime

getProfileMap

getGroupNames

getOrgNames

getRoleNames

getSpaceNames

isChangePassword

isEmailVerificationRequired