org.bonitasoft.engine.api

Interface RoleAPI

All Known Subinterfaces:

IdentityAPI, IdentityAPI

public interface RoleAPI

RoleAPI forms part of the OrganizationAPI and gives access to all the Administation operations available on Roles: creation, deletion, search, etc...

Author:

Feng Hui, Matthieu Chaffotte, Hongwen Zang, Emmanuel Duchastenier

See Also:

SearchResult for general knowledege on Search mechanism in Bonita BPM., Role

Method Summary

Methods

Modifier and Type	Method and Description
Role	createRole(RoleCreator creator) Create the role.
Role	createRole(String roleName) Creates a role.
void	deleteRole(long roleId) Deletes the role.
void	deleteRoles(List<Long> roleIds) Deletes the roles.
long	getNumberOfRoles() Returns the total number of roles.
Role	getRole(long roleId) Retrieves the role.
Role	getRoleByName(String roleName) Retrieves the role.
List<Role>	getRoles(int startIndex, int maxResults, RoleCriterion criterion) Retrieves the paginated list of roles.
Map<Long,Role>	getRoles(List<Long> roleIds) Retrieves the roles.
SearchResult<Role>	searchRoles(SearchOptions options) Searches roles according to the criteria containing in the options.
Role	updateRole(long roleId, RoleUpdater updater) Updates the group according to the updater values.

Method Detail

createRole

Role createRole(String roleName)
                throws AlreadyExistsException,
                       CreationException

Creates a role.

Parameters:

roleName - the name of the role

Returns:

the created role

Throws:

AlreadyExistsException - If the name is already taken by an existing role

CreationException - If an exception occurs during the role creation

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

Since:

6.0

createRole

Role createRole(RoleCreator creator)
                throws AlreadyExistsException,
                       CreationException

Create the role. It takes the values of the creator in order to create the role.

Parameters:

creator - the role creator

Returns:

the created role.

Throws:

AlreadyExistsException - If the name is already taken by an existing role

CreationException - If an exception occurs during the role creation

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

Since:

6.0

updateRole

Role updateRole(long roleId,
              RoleUpdater updater)
                throws RoleNotFoundException,
                       UpdateException

Updates the group according to the updater values.

Parameters:

roleId - the identifier of the role

updater - the role updater

Returns:

the updated role

Throws:

RoleNotFoundException - If the role identifier does not refer to an existing role

UpdateException - If an exception occurs during the role update

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

Since:

6.0

deleteRole

void deleteRole(long roleId)
                throws DeletionException

Deletes the role.

Parameters:

roleId - the role identifier

Throws:

DeletionException - If an exception occurs during the role deletion

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

Since:

6.0

deleteRoles

void deleteRoles(List<Long> roleIds)
                 throws DeletionException

Deletes the roles.

Parameters:

roleIds - the list of role identifiers

Throws:

DeletionException - If an exception occurs during the role deletion

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

Since:

6.0

getRole

Role getRole(long roleId)
             throws RoleNotFoundException

Retrieves the role.

Parameters:

roleId - the identifier of the role

Returns:

the role

Throws:

RoleNotFoundException - If the role identifier does not refer to an existing role

RetrieveException - If an exception occurs during the role retrieving

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

Since:

6.0

getRoleByName

Role getRoleByName(String roleName)
                   throws RoleNotFoundException

Retrieves the role.

Parameters:

roleName - the name of the role.

Returns:

the role.

Throws:

RoleNotFoundException - If the role name does not refer to an existing role

RetrieveException - If an exception occurs during the role retrieving

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

Since:

6.0

getNumberOfRoles

long getNumberOfRoles()

Returns the total number of roles.

Returns:

the total number of roles

Throws:

RetrieveException - If an exception occurs during the count retrieving

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

Since:

6.0

getRoles

List<Role> getRoles(int startIndex,
                  int maxResults,
                  RoleCriterion criterion)

Retrieves the paginated list of roles. It retrieves from the startIndex to the startIndex + maxResults.

Parameters:

startIndex - the start index

maxResults - the max number of roles

criterion - the sorting criterion

Returns:

the paginated list of roles

Throws:

RetrieveException - If an exception occurs during the role retrieving

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

Since:

6.0

getRoles

Map<Long,Role> getRoles(List<Long> roleIds)

Retrieves the roles. The map contains the couples roleId/Role. If a role does not exists, no exception is thrown and no value is added in the map.

Parameters:

roleIds - the identifiers of the roles

Returns:

the roles

Throws:

RetrieveException - If an exception occurs during the role retrieving

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

Since:

6.0

searchRoles

SearchResult<Role> searchRoles(SearchOptions options)
                               throws SearchException

Searches roles 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 role searching

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

Since:

6.0