UserUtils (edoras one Java API (2.0.5))

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

```
public class UserUtils
extends Object
```
Provides utility methods and constants related to working with users.

Field Summary

Fields
Modifier and Type	Field and Description
`static com.edorasware.api.value.StringValue<String>`	`ADDRESS` The variable that holds the address of the user.
`static com.edorasware.api.value.BooleanValue<Boolean>`	`ADMIN_USER_VARIABLE` The variable that holds the flag whether the user is the automatically created system admin user of the tenant.
`static com.edorasware.api.value.ComplexValue<Map<String,Map<String,String>>>`	`CONFIGURATION` <p>The variable that holds the configuration object of a user.
`static com.edorasware.api.value.ComplexValue<List<User.DeputyUser>>`	`DEPUTIES`
`static com.edorasware.api.value.BooleanValue<Boolean>`	`DEPUTY_ACTIVE`
`static com.edorasware.api.value.BooleanValue<Boolean>`	`DEPUTY_NOTIFY`
`static com.edorasware.api.value.StringValue<String>`	`DEPUTY_USER_ID` The variable that holds the user information who can act as user deputy.
`static String`	`EDORAS_VIS_CONFIGURATION_KEY` The key where the edoras vis configuration map is stored inside the main `CONFIGURATION` map.
`static com.edorasware.api.value.StringValue<String>`	`EMAIL_ADDRESS` The variable that holds the email address of the user.
`static com.edorasware.api.value.StringValue<String>`	`FIRST_NAME` The variable that holds the first name of the user.
`static com.edorasware.api.value.StringValue<String>`	`HOME_URL` The variable that holds the home url of the user.
`static com.edorasware.api.value.StringValue<String>`	`LANGUAGE` The variable that holds the language of the user.
`static com.edorasware.api.value.StringValue<String>`	`LAST_NAME` The variable that holds the last name of the user.
`static com.edorasware.api.value.BooleanValue<Boolean>`	`LIVE_PREVIEW` The variable that holds the live preview flag of the user.
`static com.edorasware.api.value.StringValue<String>`	`LOGIN` The variable that holds the login of the user.
`static com.edorasware.api.value.ComplexValue<Set<String>>`	`MEMBER_GROUPS` The variable that holds the work object ids of the groups the user is a member of.
`static com.edorasware.api.value.StringValue<String>`	`MOBILE_NUMBER` The variable that holds the mobile number of the user.
`static com.edorasware.api.value.StringValue<String>`	`NOTES` The variable that holds additional notes of the user.
`static com.edorasware.api.value.BooleanValue<Boolean>`	`NOTIFY_ASSIGNEE_WORK_ITEM_MODIFIED` The variable that holds the flag whether to notify the assignee of a work item about modifications of the work item.
`static com.edorasware.api.value.BooleanValue<Boolean>`	`NOTIFY_NEW_ASSIGNEE_OF_WORK_ITEM` The variable that holds the flag whether to notify a user that he/she has been assigned a task.
`static com.edorasware.api.value.BooleanValue<Boolean>`	`NOTIFY_NEW_CANDIDATE_ASSIGNEE_OF_WORK_ITEM` The variable that holds the flag whether to notify a user that he/she is a candidate to become the assignee for a currently unassigned task.
`static com.edorasware.api.value.BooleanValue<Boolean>`	`NOTIFY_OWNER_WORK_ITEM_MODIFIED` The variable that holds the flag whether to notify the owner of a work item about modifications of the work item.
`static com.edorasware.api.value.StringValue<String>`	`ORIGIN_USER_ID`
`static com.edorasware.api.value.StringValue<String>`	`ORIGIN_USER_LOGIN`
`static com.edorasware.api.value.StringValue<String>`	`ORIGIN_USER_NAME`
`static com.edorasware.api.value.StringValue<String>`	`PASSWORD` The variable that holds the password of the user.
`static com.edorasware.api.value.StringValue<String>`	`PHONE_NUMBER` The variable that holds the phone number of the user.
`static com.edorasware.api.value.ComplexValue<List<Map<String,Object>>>`	`USERS_TO_IMPERSONATE` The user to impersonante and the origin user variables are not stored on the user object.

Constructor Summary

Constructors
Constructor and Description

UserUtils(String emailValidationPattern)

Constructors
Constructor and Description
`UserUtils(String emailValidationPattern)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static User`	`convertToUser(com.edorasware.commons.core.any.AnyWorkObject userAnyWorkObject, SystemGroups systemGroups)` Converts an `AnyWorkObject` user to a `User` object.
`static com.edorasware.commons.core.any.AnyWorkObject`	`convertToWorkObject(User user)` Converts a `User` to an `AnyWorkObject` user object.
`static String`	`getEmail(com.edorasware.commons.core.any.AnyWorkObject user)` Deprecated. Please use the `EMAIL_ADDRESS` variable.
`static String`	`getLogin(com.edorasware.commons.core.any.AnyWorkObject user)` Deprecated. Please use the `LOGIN` variable.
`static Set<String>`	`getMemberGroups(com.edorasware.commons.core.any.AnyWorkObject user)` Deprecated. Please use the `MEMBER_GROUPS` variable.
`boolean`	`isValidEmailAddress(String email)` Checks if the given email address is valid.
`static boolean`	`isValidName(String name)` Checks if the given name is valid.

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

- Field Detail
  - FIRST_NAME
```
public static final com.edorasware.api.value.StringValue<String> FIRST_NAME
```
    The variable that holds the first name of the user.
  - LAST_NAME
```
public static final com.edorasware.api.value.StringValue<String> LAST_NAME
```
    The variable that holds the last name of the user.
  - LOGIN
```
public static final com.edorasware.api.value.StringValue<String> LOGIN
```
    The variable that holds the login of the user.
  - PASSWORD
```
public static final com.edorasware.api.value.StringValue<String> PASSWORD
```
    The variable that holds the password of the user.
  - LANGUAGE
```
public static final com.edorasware.api.value.StringValue<String> LANGUAGE
```
    The variable that holds the language of the user.
  - EMAIL_ADDRESS
```
public static final com.edorasware.api.value.StringValue<String> EMAIL_ADDRESS
```
    The variable that holds the email address of the user.
  - PHONE_NUMBER
```
public static final com.edorasware.api.value.StringValue<String> PHONE_NUMBER
```
    The variable that holds the phone number of the user.
  - MOBILE_NUMBER
```
public static final com.edorasware.api.value.StringValue<String> MOBILE_NUMBER
```
    The variable that holds the mobile number of the user.
  - ADDRESS
```
public static final com.edorasware.api.value.StringValue<String> ADDRESS
```
    The variable that holds the address of the user.
  - NOTES
```
public static final com.edorasware.api.value.StringValue<String> NOTES
```
    The variable that holds additional notes of the user.
  - MEMBER_GROUPS
```
public static final com.edorasware.api.value.ComplexValue<Set<String>> MEMBER_GROUPS
```
    The variable that holds the work object ids of the groups the user is a member of.
  - HOME_URL
```
public static final com.edorasware.api.value.StringValue<String> HOME_URL
```
    The variable that holds the home url of the user.
  - LIVE_PREVIEW
```
public static final com.edorasware.api.value.BooleanValue<Boolean> LIVE_PREVIEW
```
    The variable that holds the live preview flag of the user.
  - NOTIFY_OWNER_WORK_ITEM_MODIFIED
```
public static final com.edorasware.api.value.BooleanValue<Boolean> NOTIFY_OWNER_WORK_ITEM_MODIFIED
```
    The variable that holds the flag whether to notify the owner of a work item about modifications of the work item.
  - NOTIFY_ASSIGNEE_WORK_ITEM_MODIFIED
```
public static final com.edorasware.api.value.BooleanValue<Boolean> NOTIFY_ASSIGNEE_WORK_ITEM_MODIFIED
```
    The variable that holds the flag whether to notify the assignee of a work item about modifications of the work item.
  - NOTIFY_NEW_ASSIGNEE_OF_WORK_ITEM
```
public static final com.edorasware.api.value.BooleanValue<Boolean> NOTIFY_NEW_ASSIGNEE_OF_WORK_ITEM
```
    The variable that holds the flag whether to notify a user that he/she has been assigned a task.
  - NOTIFY_NEW_CANDIDATE_ASSIGNEE_OF_WORK_ITEM
```
public static final com.edorasware.api.value.BooleanValue<Boolean> NOTIFY_NEW_CANDIDATE_ASSIGNEE_OF_WORK_ITEM
```
    The variable that holds the flag whether to notify a user that he/she is a candidate to become the assignee for a currently unassigned task.
  - ADMIN_USER_VARIABLE
```
public static final com.edorasware.api.value.BooleanValue<Boolean> ADMIN_USER_VARIABLE
```
    The variable that holds the flag whether the user is the automatically created system admin user of the tenant.
  - CONFIGURATION
```
public static final com.edorasware.api.value.ComplexValue<Map<String,Map<String,String>>> CONFIGURATION
```
    <p>The variable that holds the configuration object of a user. The configuration map is structured the following way: </p> <pre> { "edorasVis": { "property1": "value1", … }, } </pre> It is a map of maps which holds the individual configuration maps to separate them from each other. The EDORAS_VIS_CONFIGURATION_KEY is the key for the edoras vis configuration object.
  - DEPUTY_USER_ID
```
public static final com.edorasware.api.value.StringValue<String> DEPUTY_USER_ID
```
    The variable that holds the user information who can act as user deputy.
  - DEPUTY_NOTIFY
```
public static final com.edorasware.api.value.BooleanValue<Boolean> DEPUTY_NOTIFY
```
  - DEPUTY_ACTIVE
```
public static final com.edorasware.api.value.BooleanValue<Boolean> DEPUTY_ACTIVE
```
  - DEPUTIES
```
public static final com.edorasware.api.value.ComplexValue<List<User.DeputyUser>> DEPUTIES
```
  - USERS_TO_IMPERSONATE
```
public static final com.edorasware.api.value.ComplexValue<List<Map<String,Object>>> USERS_TO_IMPERSONATE
```
    The user to impersonante and the origin user variables are not stored on the user object. These are just used to add the information to the user object when retrieved by the front end.
  - ORIGIN_USER_ID
```
public static final com.edorasware.api.value.StringValue<String> ORIGIN_USER_ID
```
  - ORIGIN_USER_NAME
```
public static final com.edorasware.api.value.StringValue<String> ORIGIN_USER_NAME
```
  - ORIGIN_USER_LOGIN
```
public static final com.edorasware.api.value.StringValue<String> ORIGIN_USER_LOGIN
```
  - EDORAS_VIS_CONFIGURATION_KEY
```
public static final String EDORAS_VIS_CONFIGURATION_KEY
```
    The key where the edoras vis configuration map is stored inside the main CONFIGURATION map.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserUtils
```
public UserUtils(String emailValidationPattern)
```
- Method Detail
  - isValidEmailAddress
```
public boolean isValidEmailAddress(String email)
```
    Checks if the given email address is valid.
    
    Parameters:
    
    email - the email address to check
    
    Returns:
    
    true if it is valid, false otherwise
  - isValidName
```
public static boolean isValidName(String name)
```
    Checks if the given name is valid.
    
    Parameters:
    
    name - the name to check
    
    Returns:
    
    true if it is valid, false otherwise
  - getLogin
```
@Deprecated
public static String getLogin(com.edorasware.commons.core.any.AnyWorkObject user)
```
    Deprecated. Please use the LOGIN variable.
    
    Parameters:
    
    user - the user work object.
    
    Returns:
    
    the user login.
  - getEmail
```
@Deprecated
public static String getEmail(com.edorasware.commons.core.any.AnyWorkObject user)
```
    Deprecated. Please use the EMAIL_ADDRESS variable.
    
    Parameters:
    
    user - the user work object.
    
    Returns:
    
    the user e-mail.
  - getMemberGroups
```
@Deprecated
public static Set<String> getMemberGroups(com.edorasware.commons.core.any.AnyWorkObject user)
```
    Deprecated. Please use the MEMBER_GROUPS variable.
    
    Parameters:
    
    user - the user work object.
    
    Returns:
    
    the member groups to which the user belongs.
  - convertToUser
```
public static User convertToUser(com.edorasware.commons.core.any.AnyWorkObject userAnyWorkObject,
                                 SystemGroups systemGroups)
```
    Converts an AnyWorkObject user to a User object.
    
    Parameters:
    
    userAnyWorkObject - the given AnyWorkObject user to convert to a User object
    
    systemGroups - the system groups of the tenant which are needed to set the roles of the user
    
    Returns:
    
    the converted User object
    
    Throws:
    
    IllegalArgumentException - if the given AnyWorkObject user is null
  - convertToWorkObject
```
public static com.edorasware.commons.core.any.AnyWorkObject convertToWorkObject(User user)
```
    Converts a User to an AnyWorkObject user object.
    
    Parameters:
    
    user - the given User to convert to an AnyWorkObject
    
    Returns:
    
    AnyWorkObject the converted AnyWorkObject
    
    Throws:
    
    IllegalArgumentException - if the given User object is null

Class UserUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIRST_NAME

LAST_NAME

LOGIN

PASSWORD

LANGUAGE

EMAIL_ADDRESS

PHONE_NUMBER

MOBILE_NUMBER

ADDRESS

NOTES

MEMBER_GROUPS

HOME_URL

LIVE_PREVIEW

NOTIFY_OWNER_WORK_ITEM_MODIFIED

NOTIFY_ASSIGNEE_WORK_ITEM_MODIFIED

NOTIFY_NEW_ASSIGNEE_OF_WORK_ITEM

NOTIFY_NEW_CANDIDATE_ASSIGNEE_OF_WORK_ITEM

ADMIN_USER_VARIABLE

CONFIGURATION

DEPUTY_USER_ID

DEPUTY_NOTIFY

DEPUTY_ACTIVE

DEPUTIES

USERS_TO_IMPERSONATE

ORIGIN_USER_ID

ORIGIN_USER_NAME

ORIGIN_USER_LOGIN

EDORAS_VIS_CONFIGURATION_KEY

Constructor Detail

UserUtils

Method Detail

isValidEmailAddress

isValidName

getLogin

getEmail

getMemberGroups

convertToUser

convertToWorkObject