org.bonitasoft.engine.api

Interface GroupAPI

All Known Subinterfaces:

IdentityAPI, IdentityAPI

public interface GroupAPI

GroupAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on Groups: creation, deletion, updating, search, etc...

Author:

Zhao Na, Bole Zhang, Matthieu Chaffotte, Hongwen Zang

See Also:

Group

Method Summary

Methods

Modifier and Type	Method and Description
Group	createGroup(GroupCreator creator) Creates a group.
Group	createGroup(String name, String parentPath) Creates a group from its name and parent path.
void	deleteGroup(long groupId) Deletes the group.
void	deleteGroups(List<Long> groupIds) Deletes the groups.
Group	getGroup(long groupId) Retrieves the group.
Group	getGroupByPath(String groupPath) Retrieves the group according to its full path.
List<Group>	getGroups(int startIndex, int maxResults, GroupCriterion criterion) Retrieves the paginated list of groups.
Map<Long,Group>	getGroups(List<Long> groupIds) Retrieves the groups.
long	getNumberOfGroups() Returns the total number of groups.
SearchResult<Group>	searchGroups(SearchOptions options) Searches groups according to the criteria containing in the options.
Group	updateGroup(long groupId, GroupUpdater updater) Updates the group according to the updater values.

Method Detail

createGroup

Group createGroup(String name,
                String parentPath)
                  throws AlreadyExistsException,
                         CreationException

Creates a group from its name and parent path.

If the group is a top level one, the parent path must be null.

Parameters:

name - the name of the group

parentPath - the parent path of the group (null means no parent)

Returns:

the created group

Throws:

AlreadyExistsException - If the couple name/parentPath is already taken by an existing group

CreationException - If an exception occurs during the group creation

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

createGroup

Group createGroup(GroupCreator creator)
                  throws AlreadyExistsException,
                         CreationException

Creates a group.

It takes the values of the creator in order to create a group.

Parameters:

creator - the group creator

Returns:

the created group

Throws:

AlreadyExistsException - If the couple name/parentPath is already taken by an existing group

CreationException - If an exception occurs during group creation

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

updateGroup

Group updateGroup(long groupId,
                GroupUpdater updater)
                  throws GroupNotFoundException,
                         UpdateException

Updates the group according to the updater values.

Parameters:

groupId - the identifier of the group

updater - the group updater

Returns:

the updated group

Throws:

GroupNotFoundException - If the group identifier does not refer to an existing group

UpdateException - If an exception occurs during the group update

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

deleteGroup

void deleteGroup(long groupId)
                 throws DeletionException

Deletes the group.

Parameters:

groupId - the identifier of the group

Throws:

DeletionException - If an exception occurs during the group deletion

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

deleteGroups

void deleteGroups(List<Long> groupIds)
                  throws DeletionException

Deletes the groups.

Parameters:

groupIds - the list of group identifiers

Throws:

DeletionException - If an exception occurs during the group deletion

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getGroup

Group getGroup(long groupId)
               throws GroupNotFoundException

Retrieves the group.

Parameters:

groupId - the group identifier

Returns:

the group

Throws:

GroupNotFoundException - If the group identifier does not refer to an existing group

RetrieveException - If an exception occurs during the group retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getGroupByPath

Group getGroupByPath(String groupPath)
                     throws GroupNotFoundException

Retrieves the group according to its full path.

Parameters:

groupPath - the full path of the group (parentPath/name)

Returns:

the group

Throws:

GroupNotFoundException - If the group path does not refer to an existing group

RetrieveException - If an exception occurs during the group retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getNumberOfGroups

long getNumberOfGroups()

Returns the total number of groups.

Returns:

the total number of groups

Throws:

RetrieveException - If an exception occurs during the count retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getGroups

List<Group> getGroups(int startIndex,
                    int maxResults,
                    GroupCriterion criterion)

Retrieves the paginated list of groups.

It retrieves from the startIndex to the startIndex + maxResults.

Parameters:

startIndex - the start index

maxResults - the max number of groups

criterion - the sorting criterion

Returns:

the list of groups

Throws:

RetrieveException - If an exception occurs during the group retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getGroups

Map<Long,Group> getGroups(List<Long> groupIds)

Retrieves the groups.

The map contains the couples groupId/Group. If a group does not exists, no exception is thrown and no value is added in the map.

Parameters:

groupIds - the identifiers of the groups

Returns:

the groups

Throws:

RetrieveException - If an exception occurs during the group retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

searchGroups

SearchResult<Group> searchGroups(SearchOptions options)
                                 throws SearchException

Searches groups according to the criteria containing in the options.

Parameters:

options - the search criteria

Returns:

the search result

Throws:

SearchException - If an exception occurs during the group searching

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0