UserService (edoras one Javadoc)

```
public interface UserService
```
Service that provides user related information.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class UserService.UserSearchScope
Defines the scope in which to apply a user search.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`UserService.UserSearchScope` Defines the scope in which to apply a user search.

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, UserService.UserSearchScope searchScope)` Finds the `User` that matches the given predicate.
`com.google.common.collect.ImmutableList<User>`	`findUsers(com.edorasware.commons.core.query.Predicate predicate, UserService.UserSearchScope searchScope)` Finds the `User`s that match the given predicate.
`com.edorasware.commons.core.entity.UserId`	`getSystemAdminUserId()` Returns the id of the system admin 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
  - 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:
    
    IllegalArgumentException - if the given user id is null
    
    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,
                                             UserService.UserSearchScope searchScope)
```
    Finds the User that matches the given predicate.
    
    Parameters:
    predicate - the predicate to apply, never null
    searchScope - the boundaries within which to search
    
    Returns:
    the matching user if any, never null
    
    Throws:
    
    IllegalArgumentException - if the given predicate or search scope is null
    
    IllegalStateException - if more than one matching user is found
  - findUsers
```
com.google.common.collect.ImmutableList<User> findUsers(com.edorasware.commons.core.query.Predicate predicate,
                                                      UserService.UserSearchScope searchScope)
```
    Finds the Users that match the given predicate.
    
    Parameters:
    predicate - the predicate to apply, never null
    searchScope - the boundaries within which to search
    
    Returns:
    the matching users if any, never null
    
    Throws:
    
    IllegalArgumentException - if the given predicate or search scope is null
  - getSystemAdminUserId
```
com.edorasware.commons.core.entity.UserId getSystemAdminUserId()
```
    Returns the id of the system admin user. Note that in a multi-tenant environment, the system admin user id is different for each tenant.
    
    Returns:
    the id of the system admin user, never null
    
    Throws:
    
    IllegalStateException - if none or more than one system admin 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 UserService

Nested Class Summary

Method Summary

Method Detail

getUser

setActive

findUser

findUsers

getSystemAdminUserId

createUser

updateUser