UserManager (edoras one Javadoc)

```
public interface UserManager
```
Manager to retrieve current user information. All APIs are restricted to the current tenant unless specifically noted otherwise.

Method Summary

Methods
Modifier and Type	Method and Description
`com.edorasware.commons.core.entity.UserId`	`createUser(User user)` Persists the given `User` object as an `AnyWorkObject` with type `User.ENTITY_TYPE` and the predefined user variables.
`com.google.common.base.Optional<User>`	`findUser(com.edorasware.commons.core.query.Predicate predicate)` Finds the `User` that matches the given predicate.
`com.google.common.base.Optional<User>`	`findUserAcrossAllTenants(com.edorasware.commons.core.query.Predicate predicate)` Finds the `User` that matches the given predicate across all tenants.
`com.google.common.collect.ImmutableList<User>`	`findUsers(com.edorasware.commons.core.query.Predicate predicate)` Finds the `User`s that match the given predicate.
`User`	`getCurrentSystemAdminUser()` Returns the current system admin user.
`com.edorasware.commons.core.entity.UserId`	`getCurrentSystemAdminUserId()` Returns the id of the current system admin user.
`com.edorasware.commons.core.entity.TenantId`	`getCurrentTenantId()` Returns the id of the current tenant.
`User`	`getCurrentUser()` Returns the current user.
`com.edorasware.commons.core.entity.UserId`	`getCurrentUserId()` Returns the id of the current user.
`User`	`getUser(com.edorasware.commons.core.entity.UserId userId)` Returns the user with the given id.
`void`	`setActive(com.edorasware.commons.core.entity.UserId userId, boolean isActive)` Set the state of the user object.
`com.edorasware.commons.core.entity.UserId`	`updateUser(User user)` Updates an already persisted user.

- Method Detail
  - getCurrentTenantId
```
com.edorasware.commons.core.entity.TenantId getCurrentTenantId()
```
    Returns the id of the current tenant.
    
    Returns:
    the id of the current tenant, never null
  - getCurrentUserId
```
com.edorasware.commons.core.entity.UserId getCurrentUserId()
```
    Returns the id of the current user.
    
    Returns:
    the id of the current user, never null
  - getCurrentUser
```
User getCurrentUser()
```
    Returns the current user.
    
    Returns:
    the current user, never null
  - getCurrentSystemAdminUserId
```
com.edorasware.commons.core.entity.UserId getCurrentSystemAdminUserId()
```
    Returns the id of the current system admin user.
    
    Returns:
    the id of the current system admin user, never null
  - getCurrentSystemAdminUser
```
User getCurrentSystemAdminUser()
```
    Returns the current system admin user.
    
    Returns:
    the current system admin user, never null
  - getUser
```
User getUser(com.edorasware.commons.core.entity.UserId userId)
```
    Returns the user with the given id.
    
    Parameters:
    userId - the user id, not null
    
    Returns:
    the user with the given id, never null
    
    Throws:
    
    com.edorasware.commons.core.entity.EntityNotFoundException - if a user with the given id does not exist
  - setActive
```
void setActive(com.edorasware.commons.core.entity.UserId userId,
             boolean isActive)
```
    Set the state of the user object.
    
    Parameters:
    userId - the user id, not null
    isActive - true if the user gets activated, false otherwise
  - findUser
```
com.google.common.base.Optional<User> findUser(com.edorasware.commons.core.query.Predicate predicate)
```
    Finds the User that matches the given predicate.
    
    Parameters:
    predicate - the predicate to apply, never null
    
    Returns:
    the matching user if any, never null
    
    Throws:
    
    IllegalStateException - if more than one matching user is found
  - findUsers
```
com.google.common.collect.ImmutableList<User> findUsers(com.edorasware.commons.core.query.Predicate predicate)
```
    Finds the Users that match the given predicate.
    
    Parameters:
    predicate - the predicate to apply, never null
    
    Returns:
    the matching users if any, never null
  - findUserAcrossAllTenants
```
com.google.common.base.Optional<User> findUserAcrossAllTenants(com.edorasware.commons.core.query.Predicate predicate)
```
    Finds the User that matches the given predicate across all tenants.
    
    Parameters:
    predicate - the predicate to apply, never null
    
    Returns:
    the matching user if any, never null
    
    Throws:
    
    IllegalStateException - if more than one matching user is found
  - createUser
```
com.edorasware.commons.core.entity.UserId createUser(User user)
```
    Persists the given User object as an AnyWorkObject with type User.ENTITY_TYPE and the predefined user variables.
    
    Parameters:
    user - the user to be created, not null
    
    Returns:
    the user id of the created user
    
    Throws:
    
    IllegalArgumentException - if the given user is null or the given user email address is not valid
    
    IllegalStateException - if a user is already persisted with the same login as the given user
  - updateUser
```
com.edorasware.commons.core.entity.UserId updateUser(User user)
```
    Updates an already persisted user. All user properties are updated except the following id's:
    Parameters:
    user - the user to be updated, not null
    
    Returns:
    the user id of the updated user
    
    Throws:
    
    IllegalArgumentException - if the given user is null, the id of the user is undefined or the given user email address is not valid
    
    IllegalStateException - if the id of the given user is not already persisted or if a user is already persisted with the same login as the given user

Interface UserManager

Method Summary

Method Detail

getCurrentTenantId

getCurrentUserId

getCurrentUser

getCurrentSystemAdminUserId

getCurrentSystemAdminUser

getUser

setActive

findUser

findUsers

findUserAcrossAllTenants

createUser

updateUser