com.edorasware.one.identity.group

Interface GroupManager

All Known Implementing Classes:

DefaultGroupManager

public interface GroupManager

Manager to retrieve current group information. All APIs are restricted to the current tenant unless specifically noted otherwise.

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) Finds the Group that matches the given predicate.
com.google.common.collect.ImmutableList<Group>	findGroups(com.edorasware.api.query.Predicate predicate) Finds the Groups that match the given predicate.
SystemGroups	getCurrentSystemGroups() Returns the current system groups.
Group	getGroup(String groupId) Returns the group with the given id.
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:

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

getCurrentSystemGroups

SystemGroups getCurrentSystemGroups()

Returns the current system groups.

Returns:

the current system groups, never null

findGroup

Optional<Group> findGroup(com.edorasware.api.query.Predicate predicate)

Finds the Group that matches the given predicate.

Parameters:

predicate - the predicate to apply, never null

Returns:

the matching group if any, never null

Throws:

IllegalStateException - if more than one matching user is found

findGroups

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

Finds the Groups that match the given predicate.

Parameters:

predicate - the predicate to apply, never null

Returns:

the matching groups if any, never 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