org.bonitasoft.engine.supervisor.mapping

Interface SupervisorMappingService

All Known Implementing Classes:

SupervisorMappingServiceImpl

public interface SupervisorMappingService

Since:

6.0

Author:

Yanyan Liu, Elias Ricken de Medeiros, Matthieu Chaffotte, Celine Souchet

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SUPERVISOR

Method Summary

Modifier and Type	Method and Description
SProcessSupervisor	createProcessSupervisor(SProcessSupervisor supervisor) Create supervisor in DB according to the given supervisor
void	deleteAllProcessSupervisors() Delete all supervisors for the connected tenant
void	deleteProcessSupervisor(long supervisorId) Delete the id specified supervisor
void	deleteProcessSupervisor(SProcessSupervisor supervisor) Delete the specific supervisor
long	getNumberOfProcessSupervisors(QueryOptions searchOptions) Get total number of supervisors suit to the specific criteria
SProcessSupervisor	getProcessSupervisor(long supervisorId) get supervisor without display name by its id
java.lang.Boolean	isProcessSupervisor(long processDefinitionId, long userId) Verify if the id specified user is the supervisor of id specified process definition
java.util.List<SProcessSupervisor>	searchProcessSupervisors(QueryOptions queryOptions) Search all supervisors suit to the specific criteria

Field Detail

SUPERVISOR

static final java.lang.String SUPERVISOR

See Also:

Constant Field Values

Method Detail

createProcessSupervisor

SProcessSupervisor createProcessSupervisor(SProcessSupervisor supervisor)
                                    throws SSupervisorCreationException

Create supervisor in DB according to the given supervisor

Parameters:

supervisor - a SSupervisor object

Returns:

the new created supervisor

Throws:

SSupervisorCreationException

getProcessSupervisor

SProcessSupervisor getProcessSupervisor(long supervisorId)
                                 throws SSupervisorNotFoundException

get supervisor without display name by its id

Parameters:

supervisorId - identifier of supervisor

Returns:

the supervisor with id equals the parameter

Throws:

SSupervisorNotFoundException

deleteProcessSupervisor

void deleteProcessSupervisor(long supervisorId)
                      throws SSupervisorNotFoundException,
                             SSupervisorDeletionException

Delete the id specified supervisor

Parameters:

supervisorId - identifier of supervisor

Throws:

SSupervisorNotFoundException

SSupervisorDeletionException

deleteProcessSupervisor

void deleteProcessSupervisor(SProcessSupervisor supervisor)
                      throws SSupervisorDeletionException

Delete the specific supervisor

Parameters:

supervisor - the supervisor will be deleted

Throws:

SSupervisorDeletionException

deleteAllProcessSupervisors

void deleteAllProcessSupervisors()
                          throws SSupervisorDeletionException

Delete all supervisors for the connected tenant

Throws:

SSupervisorDeletionException

Since:

6.1

isProcessSupervisor

java.lang.Boolean isProcessSupervisor(long processDefinitionId,
                                      long userId)
                               throws SBonitaReadException

Verify if the id specified user is the supervisor of id specified process definition

Parameters:

processDefinitionId - identifier of process definition

userId - identifier of user

Returns:

true if user is supervisor of the process, false otherwise

Throws:

SBonitaReadException

searchProcessSupervisors

java.util.List<SProcessSupervisor> searchProcessSupervisors(QueryOptions queryOptions)
                                                     throws SBonitaReadException

Search all supervisors suit to the specific criteria

Parameters:

queryOptions - The QueryOptions object containing some query conditions

Returns:

a list of SSupervisor objects

Throws:

SBonitaReadException

getNumberOfProcessSupervisors

long getNumberOfProcessSupervisors(QueryOptions searchOptions)
                            throws SBonitaReadException

Get total number of supervisors suit to the specific criteria

Parameters:

searchOptions - The QueryOptions object containing some query conditions

Returns:

a list of SSupervisor objects

Throws:

SBonitaReadException