com.edorasware.one.identity.group

Interface GroupService

All Known Implementing Classes:

DefaultGroupService

public interface GroupService

Service that provides user and group related information.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GroupService.GroupSearchScope Defines the scope in which to apply a group search.

Method Summary

Modifier and Type	Method and Description
String	createGroup(Group group) Persists the given Group object as an AnyWorkObject with type WorkObjectTypes.GROUP_TYPE.
Optional<Group>	findGroup(com.edorasware.api.query.Predicate predicate, GroupService.GroupSearchScope searchScope) Finds the Group that matches the given predicate.
com.google.common.collect.ImmutableList<Group>	findGroups(com.edorasware.api.query.Predicate predicate, GroupService.GroupSearchScope searchScope) Finds the Groups that match the given predicate.
Group	getGroup(String groupId) Returns the Group with the given id.
SystemGroups	getSystemGroups(String tenantId) Returns the ids of the system groups for the specified tenant.
String	updateGroup(Group group) Updates an already persisted group.

Method Detail

getGroup

Group getGroup(String groupId)

Returns the Group with the given id.

Parameters:

groupId - the group id, not null

Returns:

the group with the given id, never null

Throws:

IllegalArgumentException - if the given group id is null

com.edorasware.api.exception.EntityNotFoundException - if a group with the given id does not exist

getSystemGroups

SystemGroups getSystemGroups(String tenantId)

Returns the ids of the system groups for the specified tenant.

Parameters:

tenantId - the tenant id for which the system groups are returned, not null

Returns:

the ids of the system groups, never null

Throws:

RuntimeException - if the system groups cannot be found

findGroup

Optional<Group> findGroup(com.edorasware.api.query.Predicate predicate,
                          GroupService.GroupSearchScope searchScope)

Finds the Group that matches the given predicate.

Parameters:

predicate - the predicate to apply, never null

searchScope - the boundaries within which to search

Returns:

the matching group if any, never null

Throws:

IllegalArgumentException - if the given predicate or search scope is null

IllegalStateException - if more than one matching group is found

findGroups

com.google.common.collect.ImmutableList<Group> findGroups(com.edorasware.api.query.Predicate predicate,
                                                          GroupService.GroupSearchScope searchScope)

Finds the Groups that match the given predicate.

Parameters:

predicate - the predicate to apply, never null

searchScope - the boundaries within which to search

Returns:

the matching groups if any, never null

Throws:

IllegalArgumentException - if the given predicate or search scope is null

createGroup

String createGroup(Group group)

Persists the given Group object as an AnyWorkObject with type WorkObjectTypes.GROUP_TYPE.

Parameters:

group - the group to be created, not null

Returns:

the group id of the created group

Throws:

IllegalArgumentException - if the given group is null

updateGroup

String updateGroup(Group group)

Updates an already persisted group. All group properties are updated except the following id’s: <ul> <li>Group.id</li> <li>Group.externalId</li> <li>Group.tenantId</li> </ul>

Parameters:

group - the group to be updated, not null

Returns:

the group id of the updated user

Throws:

IllegalArgumentException - if the given group is null or the id of the group is undefined