User (edoras one Java API (2.0.7))

java.lang.Object
- com.edorasware.one.identity.user.User

```
public class User
extends Object
```
Represents a user.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class User.Builder
Builder for User class.

static class User.DeputyUser
This class represents a deputy user.

Nested Classes
Modifier and Type	Class and Description
`static class`	`User.Builder` Builder for `User` class.
`static class`	`User.DeputyUser` This class represents a deputy user.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static User.Builder`	`builder()` Creates a builder for a new concrete `User` instance.
`static User.Builder`	`builder(User userTemplate)` Creates a builder for a new concrete `User` instance based on the given `User` template.
`boolean`	`equals(Object other)`
`String`	`getAccountId()` Returns the id of the account to which the user belongs.
`String`	`getAddress()` Returns the address of the user.
`com.google.common.collect.ImmutableList<User.DeputyUser>`	`getDeputies()` Returns the ids of the users to which user can be switched.
`String`	`getDisplayName()` Returns the display name of the user.
`String`	`getEmail()` Returns the email address of the user.
`String`	`getExternalId()` Returns the external id of the user.
`String`	`getFirstName()` Returns the first name of the user.
`String`	`getHomeUrl()` Returns user’s home url
`String`	`getId()` Returns the id of the user.
`String`	`getLanguage()` Returns the language of the user.
`String`	`getLastName()` Returns the last name of the user.
`String`	`getLogin()` Returns the login of the user.
`com.google.common.collect.ImmutableSet<String>`	`getMemberGroups()` Returns the ids of the groups of which the user is a member of.
`String`	`getMobile()` Returns the mobile number of the user.
`String`	`getNotes()` Returns the notes of the user.
`com.google.common.collect.ImmutableSet<UserNotification>`	`getNotifications()` Return the notifications that the user has subscribed to.
`String`	`getPassword()` Returns the password of the user.
`String`	`getPhone()` Returns the phone number of the user.
`com.google.common.collect.ImmutableSet<SystemRole>`	`getRoles()` Returns the system roles of the user.
`String`	`getTenantId()` Returns the id of the main tenant to which the user belongs.
`Map<String,Object>`	`getVariables()` Returns any optional additional variables attached to this user.
`boolean`	`hasAnyRoleOf(Set<SystemRole> roles)` Checks if the user has any of the given roles.
`boolean`	`hasAnyRoleOf(SystemRole role)` Checks if the user has the given role.
`boolean`	`hasAnyRoleOf(SystemRole first, SystemRole second, SystemRole... more)` Checks if the user has any of the given roles.
`int`	`hashCode()`
`boolean`	`hasNotification(UserNotification notification)` Checks if the user has subscribed to the given notification option.
`boolean`	`isActive()` Returns true if the user is active
`boolean`	`isAdmin()` Returns true if the user is an admin user.
`boolean`	`isLivePreview()`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static User.Builder builder()
```
    Creates a builder for a new concrete User instance.
    
    Returns:
    
    the builder
  - builder
```
public static User.Builder builder(User userTemplate)
```
    Creates a builder for a new concrete User instance based on the given User template.
    
    Parameters:
    
    userTemplate - the user template.
    
    Returns:
    
    the builder based on the given template
  - getId
```
public String getId()
```
    Returns the id of the user.
    
    Returns:
    
    the id of the user, never null
  - getExternalId
```
public String getExternalId()
```
    Returns the external id of the user.
    
    Returns:
    
    the external id of the user, never null
  - getFirstName
```
public String getFirstName()
```
    Returns the first name of the user.
    
    Returns:
    
    the first name of the user, never null
  - getLastName
```
public String getLastName()
```
    Returns the last name of the user.
    
    Returns:
    
    the last name of the user, never null
  - getDisplayName
```
public String getDisplayName()
```
    Returns the display name of the user.
    
    Returns:
    
    the display name of the user, never null
  - getLogin
```
public String getLogin()
```
    Returns the login of the user.
    
    Returns:
    
    the login of the user, never null
  - getPassword
```
public String getPassword()
```
    Returns the password of the user.
    
    Returns:
    
    the password of the user, never null
  - getLanguage
```
public String getLanguage()
```
    Returns the language of the user.
    
    Returns:
    
    the language of the user, never null
  - getEmail
```
public String getEmail()
```
    Returns the email address of the user.
    
    Returns:
    
    the email address of the user, never null
  - getPhone
```
public String getPhone()
```
    Returns the phone number of the user.
    
    Returns:
    
    the phone number of the user, can be null
  - getMobile
```
public String getMobile()
```
    Returns the mobile number of the user.
    
    Returns:
    
    the mobile number of the user, can be null
  - getAddress
```
public String getAddress()
```
    Returns the address of the user.
    
    Returns:
    
    the address of the user, can be null
  - getNotes
```
public String getNotes()
```
    Returns the notes of the user.
    
    Returns:
    
    the notes of the user, can be null
  - isAdmin
```
public boolean isAdmin()
```
    Returns true if the user is an admin user.
    
    Returns:
    
    true if the user is an admin user, false otherwise
  - isActive
```
public boolean isActive()
```
    Returns true if the user is active
    
    Returns:
    
    true if the user is active, false otherwise
  - getAccountId
```
public String getAccountId()
```
    Returns the id of the account to which the user belongs.
    
    Returns:
    
    the id of the user’s account, never null
  - getTenantId
```
public String getTenantId()
```
    Returns the id of the main tenant to which the user belongs. Note that the <i>current</i> tenant id might be different from the tenant id returned by this method.
    
    Returns:
    
    the id of the user’s main tenant, never null
  - getMemberGroups
```
public com.google.common.collect.ImmutableSet<String> getMemberGroups()
```
    Returns the ids of the groups of which the user is a member of.
    
    Returns:
    
    the ids of the groups of the user, never null
  - getDeputies
```
public com.google.common.collect.ImmutableList<User.DeputyUser> getDeputies()
```
    Returns the ids of the users to which user can be switched.
    
    Returns:
    
    the ids of the users to which user can be switched, never null
  - getNotifications
```
public com.google.common.collect.ImmutableSet<UserNotification> getNotifications()
```
    Return the notifications that the user has subscribed to.
    
    Returns:
    
    the subscribed notifications
  - hasNotification
```
public boolean hasNotification(UserNotification notification)
```
    Checks if the user has subscribed to the given notification option.
    
    Parameters:
    
    notification - the notification option to check for
    
    Returns:
    
    true if the user has subscribed to the given notification option
  - getRoles
```
public com.google.common.collect.ImmutableSet<SystemRole> getRoles()
```
    Returns the system roles of the user.
    
    Returns:
    
    the system roles of the user, never null
  - hasAnyRoleOf
```
public boolean hasAnyRoleOf(SystemRole role)
```
    Checks if the user has the given role.
    
    Parameters:
    
    role - the role to check for
    
    Returns:
    
    true if the user has the given role
  - hasAnyRoleOf
```
public boolean hasAnyRoleOf(SystemRole first,
                            SystemRole second,
                            SystemRole... more)
```
    Checks if the user has any of the given roles.
    
    Parameters:
    
    first - first role to check for
    
    second - second role to check for
    
    more - more roles to check for
    
    Returns:
    
    true if the user has any of the given roles
  - hasAnyRoleOf
```
public boolean hasAnyRoleOf(Set<SystemRole> roles)
```
    Checks if the user has any of the given roles.
    
    Parameters:
    
    roles - the roles to check for
    
    Returns:
    
    true if the user has any of the given roles
  - getHomeUrl
```
public String getHomeUrl()
```
    Returns user’s home url
    
    Returns:
    
    user’s home url, can be null
  - getVariables
```
public Map<String,Object> getVariables()
```
    Returns any optional additional variables attached to this user.
    
    Returns:
    
    any optional values of this user, might be null or empty
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isLivePreview
```
public boolean isLivePreview()
```

Class User

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

builder

getId

getExternalId

getFirstName

getLastName

getDisplayName

getLogin

getPassword

getLanguage

getEmail

getPhone

getMobile

getAddress

getNotes

isAdmin

isActive

getAccountId

getTenantId

getMemberGroups

getDeputies

getNotifications

hasNotification

getRoles

hasAnyRoleOf

hasAnyRoleOf

hasAnyRoleOf

getHomeUrl

getVariables

equals

hashCode

toString

isLivePreview