Package org.bonitasoft.engine.core.process.instance.impl

Class ProcessInstanceServiceImpl

java.lang.Object

org.bonitasoft.engine.core.process.instance.impl.ProcessInstanceServiceImpl

All Implemented Interfaces:

ProcessInstanceService

public class ProcessInstanceServiceImpl
extends java.lang.Object
implements ProcessInstanceService

Author:

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

Field Summary

Fields inherited from interface org.bonitasoft.engine.core.process.instance.api.ProcessInstanceService

EVENT_TRIGGER_INSTANCE, PROCESS_INSTANCE_CATEGORY_STATE, PROCESSINSTANCE, PROCESSINSTANCE_STATE, PROCESSINSTANCE_STATE_UPDATED, PROCESSINSTANCE_TOKEN_COUNT

Constructor Summary

Constructors

Constructor

Description

ProcessInstanceServiceImpl(Recorder recorder, ReadPersistenceService persistenceRead, ActivityInstanceService activityService, EventInstanceService bpmEventInstanceService, DataInstanceService dataInstanceService, ArchiveService archiveService, ProcessDefinitionService processDefinitionService, ConnectorInstanceService connectorInstanceService, ClassLoaderService classLoaderService, DocumentService documentService, SCommentService commentService, RefBusinessDataService refBusinessDataService, ContractDataService contractDataService)

Method Summary

Modifier and Type	Method	Description
protected void	checkIfCallerIsNotActive(long callerId)
void	createProcessInstance(SProcessInstance processInstance)	Create process instance in DB according to the given process instance object
void	deleteArchivedProcessInstance(SAProcessInstance archivedProcessInstance)	Delete specified archived process instance
int	deleteArchivedProcessInstances(java.util.List<java.lang.Long> sourceProcessInstanceIds)	delete archived process instances using a list of root source process instance ids If the given id is not a root process instance (but a called process) it will not be deleted along with its elements.
protected void	deleteConnectorInstancesIfNecessary(SFlowNodeInstance flowNodeInstance, SProcessDefinition processDefinition)
void	deleteFlowNodeInstance(SFlowNodeInstance flowNodeInstance, SProcessDefinition processDefinition)
long	deleteParentProcessInstanceAndElements(java.util.List<SProcessInstance> sProcessInstances)	Delete the specified process instances with id, and their elements archived and not, if are not a subProcess
void	deleteParentProcessInstanceAndElements(SProcessInstance sProcessInstance)	Delete the specified process instance, and its elements archived and not, if are not a subProcess
void	deleteProcessInstance(long processInstanceId)	Delete the id specified process instance
void	deleteProcessInstance(SProcessInstance sProcessInstance)	Delete the specified process instance
protected void	deleteProcessInstanceElements(SProcessInstance processInstance)
java.util.List<java.lang.Long>	getArchivedChildrenSourceObjectIdsFromRootProcessInstance(long rootProcessInstanceId, int fromIndex, int maxResults, OrderByType sortingOrder)	Get the list of sourceObjectIds for archived process instances children of process instance identified by rootProcessIntanceId
SAProcessInstance	getArchivedProcessInstance(long archivedProcessInstanceId)	Get the latest archived process instance object for the specific process instance
java.util.List<SAProcessInstance>	getArchivedProcessInstancesInAllStates(java.util.List<java.lang.Long> processInstanceIds)	Get the archived process instances corresponding to the identifiers
java.util.List<java.lang.Long>	getChildInstanceIdsOfProcessInstance(long processInstanceId, int fromIndex, int maxResults, java.lang.String sortingField, OrderByType sortingOrder)	Get child instance identifiers for specific process instance, this can be used for pagination
SProcessInstance	getChildOfActivity(long activityInstId)	Get child process instance for the specific call activity or subprocess activity
SAProcessInstance	getLastArchivedProcessInstance(long processInstanceId)
long	getNumberOfArchivedProcessInstances(QueryOptions queryOptions)	Get total number of archived process instances according to specific criteria
long	getNumberOfArchivedProcessInstancesInvolvingUser(long userId, QueryOptions countOptions)	Get total number of archived process instance involving the specific user
long	getNumberOfArchivedProcessInstancesSupervisedBy(long userId, QueryOptions countOptions)	Get total number of archived process instance for the specific supervisor
long	getNumberOfArchivedProcessInstancesWithoutSubProcess(QueryOptions queryOptions)	Get total number of archived process instance according to the search criteria
long	getNumberOfChildInstancesOfProcessInstance(long processInstanceId)	Get total number of child instance for specific process instance
long	getNumberOfFailedProcessInstances(QueryOptions queryOptions)	Get the number of the SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state.
long	getNumberOfFailedProcessInstancesSupervisedBy(long userId, QueryOptions queryOptions)	Get total number of SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state for the specific supervisor
long	getNumberOfOpenProcessInstancesInvolvingUser(long userId, QueryOptions queryOptions)	Get total number of open process instance involving the specific user
long	getNumberOfOpenProcessInstancesInvolvingUsersManagedBy(long managerUserId, QueryOptions queryOptions)	Get total number of open process instance involving all users of the specific manager
long	getNumberOfOpenProcessInstancesSupervisedBy(long userId, QueryOptions queryOptions)	Get total number of open process instances for the specific supervisor
long	getNumberOfProcessInstances(long processDefinitionId)
long	getNumberOfProcessInstances(QueryOptions queryOptions)	Get total number of process instances
SProcessInstance	getProcessInstance(long processInstanceId)	Get process instance by its id
java.util.List<java.lang.Long>	getProcessInstanceIdsToRecover(java.time.Duration considerElementsOlderThan, QueryOptions queryOptions)	Retrieve ids of process instances nodes that needs to be recovered.
java.util.List<java.lang.Long>	getSourceProcessInstanceIdsOfArchProcessInstancesFromDefinition(long processDefinitionId, int fromIndex, int maxResults, OrderByType sortingOrder)
protected java.util.Set<java.lang.Integer>	getStateIdsFromStates(org.bonitasoft.engine.bpm.process.ProcessInstanceState... states)
java.util.List<SAProcessInstance>	searchArchivedProcessInstances(QueryOptions queryOptions)	Search all archived process instance according to specific criteria
java.util.List<SAProcessInstance>	searchArchivedProcessInstancesInvolvingUser(long userId, QueryOptions queryOptions)	Search all archived process instance involving the specific user
java.util.List<SAProcessInstance>	searchArchivedProcessInstancesSupervisedBy(long userId, QueryOptions queryOptions)	Search all archived process instance for the specific supervisor
java.util.List<SAProcessInstance>	searchArchivedProcessInstancesWithoutSubProcess(QueryOptions queryOptions)	Search all archived process instance according to the search criteria
java.util.List<SProcessInstance>	searchFailedProcessInstances(QueryOptions queryOptions)	List all SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state.
java.util.List<SProcessInstance>	searchFailedProcessInstancesSupervisedBy(long userId, QueryOptions queryOptions)	Search all SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state for the specific supervisor
java.util.List<SProcessInstance>	searchOpenProcessInstancesInvolvingUser(long userId, QueryOptions queryOptions)	Search all open process instance involving the specific user
java.util.List<SProcessInstance>	searchOpenProcessInstancesInvolvingUsersManagedBy(long managerUserId, QueryOptions queryOptions)	Search all open process instance involving all users of the specific manager
java.util.List<SProcessInstance>	searchOpenProcessInstancesSupervisedBy(long userId, QueryOptions queryOptions)	Search all open process instances for the specific supervisor
java.util.List<SProcessInstance>	searchProcessInstances(QueryOptions queryOptions)	Search all process instance according to specific criteria
void	setInterruptingEventId(long parentProcessInstanceId, long eventInstanceId)	Set which event interrupted the process instance
void	setState(SProcessInstance processInstance, org.bonitasoft.engine.bpm.process.ProcessInstanceState state)	Set state for the processInstance
void	setStateCategory(SProcessInstance processInstance, SStateCategory stateCatetory)	Set process state category for the given process instance
void	updateProcess(SProcessInstance processInstance, EntityUpdateDescriptor descriptor)	Update the specific process instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessInstanceServiceImpl

public ProcessInstanceServiceImpl(Recorder recorder,
                                  ReadPersistenceService persistenceRead,
                                  ActivityInstanceService activityService,
                                  EventInstanceService bpmEventInstanceService,
                                  DataInstanceService dataInstanceService,
                                  ArchiveService archiveService,
                                  ProcessDefinitionService processDefinitionService,
                                  ConnectorInstanceService connectorInstanceService,
                                  ClassLoaderService classLoaderService,
                                  DocumentService documentService,
                                  SCommentService commentService,
                                  RefBusinessDataService refBusinessDataService,
                                  ContractDataService contractDataService)

Method Detail

createProcessInstance

public void createProcessInstance(SProcessInstance processInstance)
                           throws SProcessInstanceCreationException

Description copied from interface: ProcessInstanceService

Create process instance in DB according to the given process instance object

Specified by:

createProcessInstance in interface ProcessInstanceService

Parameters:

processInstance - the processInstance

Throws:

SProcessInstanceCreationException

getProcessInstance

public SProcessInstance getProcessInstance(long processInstanceId)
                                    throws SProcessInstanceReadException,
                                           SProcessInstanceNotFoundException

Description copied from interface: ProcessInstanceService

Get process instance by its id

Specified by:

getProcessInstance in interface ProcessInstanceService

Parameters:

processInstanceId - identifier of process instance

Returns:

the process instance object

Throws:

SProcessInstanceReadException

SProcessInstanceNotFoundException

deleteProcessInstance

public void deleteProcessInstance(long processInstanceId)
                           throws SProcessInstanceModificationException,
                                  SProcessInstanceReadException,
                                  SProcessInstanceNotFoundException

Description copied from interface: ProcessInstanceService

Delete the id specified process instance

Specified by:

deleteProcessInstance in interface ProcessInstanceService

Parameters:

processInstanceId - identifier of process instance

Throws:

SProcessInstanceModificationException

SProcessInstanceReadException

SProcessInstanceNotFoundException

deleteParentProcessInstanceAndElements

public long deleteParentProcessInstanceAndElements(java.util.List<SProcessInstance> sProcessInstances)
                                            throws SBonitaException

Description copied from interface: ProcessInstanceService

Delete the specified process instances with id, and their elements archived and not, if are not a subProcess

Specified by:

deleteParentProcessInstanceAndElements in interface ProcessInstanceService

Parameters:

sProcessInstances - list of process instances to deleted

Returns:

Number of deleted process instances

Throws:

SBonitaException

deleteParentProcessInstanceAndElements

public void deleteParentProcessInstanceAndElements(SProcessInstance sProcessInstance)
                                            throws SBonitaException

Description copied from interface: ProcessInstanceService

Delete the specified process instance, and its elements archived and not, if are not a subProcess

Specified by:

deleteParentProcessInstanceAndElements in interface ProcessInstanceService

Parameters:

sProcessInstance - The SProcessInstance to delete

Throws:

SBonitaException

deleteArchivedProcessInstances

public int deleteArchivedProcessInstances(java.util.List<java.lang.Long> sourceProcessInstanceIds)
                                   throws SBonitaException

Description copied from interface: ProcessInstanceService

delete archived process instances using a list of root source process instance ids If the given id is not a root process instance (but a called process) it will not be deleted along with its elements.

Specified by:

deleteArchivedProcessInstances in interface ProcessInstanceService

Parameters:

sourceProcessInstanceIds - list of root source process instance ids

Returns:

the number of archived elements deleted (might be greater than the number of ids given)

Throws:

SBonitaException

deleteArchivedProcessInstance

public void deleteArchivedProcessInstance(SAProcessInstance archivedProcessInstance)
                                   throws SProcessInstanceModificationException

Description copied from interface: ProcessInstanceService

Delete specified archived process instance

Specified by:

deleteArchivedProcessInstance in interface ProcessInstanceService

Parameters:

archivedProcessInstance - the archived process instance

Throws:

SProcessInstanceModificationException

getSourceProcessInstanceIdsOfArchProcessInstancesFromDefinition

public java.util.List<java.lang.Long> getSourceProcessInstanceIdsOfArchProcessInstancesFromDefinition(long processDefinitionId,
                                                                                                      int fromIndex,
                                                                                                      int maxResults,
                                                                                                      OrderByType sortingOrder)
                                                                                               throws SProcessInstanceReadException

Specified by:

getSourceProcessInstanceIdsOfArchProcessInstancesFromDefinition in interface ProcessInstanceService

Returns:

Throws:

SProcessInstanceReadException

deleteProcessInstance

public void deleteProcessInstance(SProcessInstance sProcessInstance)
                           throws SProcessInstanceModificationException

Description copied from interface: ProcessInstanceService

Delete the specified process instance

Specified by:

deleteProcessInstance in interface ProcessInstanceService

Parameters:

sProcessInstance - the process instance

Throws:

SProcessInstanceModificationException

checkIfCallerIsNotActive

protected void checkIfCallerIsNotActive(long callerId)
                                 throws SFlowNodeReadException,
                                        SProcessInstanceHierarchicalDeletionException

Throws:

SFlowNodeReadException

SProcessInstanceHierarchicalDeletionException

deleteProcessInstanceElements

protected void deleteProcessInstanceElements(SProcessInstance processInstance)
                                      throws SBonitaException

Throws:

SBonitaException

deleteConnectorInstancesIfNecessary

protected void deleteConnectorInstancesIfNecessary(SFlowNodeInstance flowNodeInstance,
                                                   SProcessDefinition processDefinition)
                                            throws SConnectorInstanceReadException,
                                                   SConnectorInstanceDeletionException

Throws:

SConnectorInstanceReadException

SConnectorInstanceDeletionException

deleteFlowNodeInstance

public void deleteFlowNodeInstance(SFlowNodeInstance flowNodeInstance,
                                   SProcessDefinition processDefinition)
                            throws SProcessInstanceModificationException

Specified by:

deleteFlowNodeInstance in interface ProcessInstanceService

Throws:

SProcessInstanceModificationException

setState

public void setState(SProcessInstance processInstance,
                     org.bonitasoft.engine.bpm.process.ProcessInstanceState state)
              throws SProcessInstanceModificationException

Description copied from interface: ProcessInstanceService

Set state for the processInstance

Specified by:

setState in interface ProcessInstanceService

Parameters:

processInstance - the process instance will be updated

state - the state will be set to the process instance

Throws:

SProcessInstanceModificationException

setStateCategory

public void setStateCategory(SProcessInstance processInstance,
                             SStateCategory stateCatetory)
                      throws SProcessInstanceModificationException

Description copied from interface: ProcessInstanceService

Set process state category for the given process instance

Specified by:

setStateCategory in interface ProcessInstanceService

Parameters:

processInstance - process instance to update

stateCatetory - new category state for the process instance

Throws:

SProcessInstanceModificationException

getChildInstanceIdsOfProcessInstance

public java.util.List<java.lang.Long> getChildInstanceIdsOfProcessInstance(long processInstanceId,
                                                                           int fromIndex,
                                                                           int maxResults,
                                                                           java.lang.String sortingField,
                                                                           OrderByType sortingOrder)
                                                                    throws SProcessInstanceReadException

Description copied from interface: ProcessInstanceService

Get child instance identifiers for specific process instance, this can be used for pagination

Specified by:

getChildInstanceIdsOfProcessInstance in interface ProcessInstanceService

Parameters:

processInstanceId - identifier of process instance

fromIndex - Index of the record to be retrieved from. First record has index 0

maxResults - Number of result we want to get. Maximum number of result returned

sortingField - the field used to do order

sortingOrder - ASC or DESC

Returns:

a list of identifiers

Throws:

SProcessInstanceReadException

getChildOfActivity

public SProcessInstance getChildOfActivity(long activityInstId)
                                    throws SProcessInstanceNotFoundException,
                                           SBonitaReadException

Description copied from interface: ProcessInstanceService

Get child process instance for the specific call activity or subprocess activity

Specified by:

getChildOfActivity in interface ProcessInstanceService

Parameters:

activityInstId - identifier of call activity or subprocess activity

Returns:

an SProcessInstance object

Throws:

SProcessInstanceNotFoundException

SBonitaReadException

getNumberOfChildInstancesOfProcessInstance

public long getNumberOfChildInstancesOfProcessInstance(long processInstanceId)
                                                throws SProcessInstanceReadException

Description copied from interface: ProcessInstanceService

Get total number of child instance for specific process instance

Specified by:

getNumberOfChildInstancesOfProcessInstance in interface ProcessInstanceService

Parameters:

processInstanceId - identifier of process instance

Returns:

number of child instance for the process instance

Throws:

SProcessInstanceReadException

getNumberOfProcessInstances

public long getNumberOfProcessInstances(QueryOptions queryOptions)
                                 throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get total number of process instances

Specified by:

getNumberOfProcessInstances in interface ProcessInstanceService

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

total number of process instances

Throws:

SBonitaReadException

searchProcessInstances

public java.util.List<SProcessInstance> searchProcessInstances(QueryOptions queryOptions)
                                                        throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Search all process instance according to specific criteria

Specified by:

searchProcessInstances in interface ProcessInstanceService

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

a list of SProcessInstance objects

Throws:

SBonitaReadException

getNumberOfOpenProcessInstancesSupervisedBy

public long getNumberOfOpenProcessInstancesSupervisedBy(long userId,
                                                        QueryOptions queryOptions)
                                                 throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get total number of open process instances for the specific supervisor

Specified by:

getNumberOfOpenProcessInstancesSupervisedBy in interface ProcessInstanceService

Parameters:

userId - identifier of supervisor user

queryOptions - a map of specific parameters of a query

Returns:

number of open process instance for the specific supervisor

Throws:

SBonitaReadException

searchOpenProcessInstancesSupervisedBy

public java.util.List<SProcessInstance> searchOpenProcessInstancesSupervisedBy(long userId,
                                                                               QueryOptions queryOptions)
                                                                        throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Search all open process instances for the specific supervisor

Specified by:

searchOpenProcessInstancesSupervisedBy in interface ProcessInstanceService

Parameters:

userId - identifier of supervisor user

queryOptions - a map of specific parameters of a query

Returns:

a list of SProcessInstance objects

Throws:

SBonitaReadException

getNumberOfFailedProcessInstancesSupervisedBy

public long getNumberOfFailedProcessInstancesSupervisedBy(long userId,
                                                          QueryOptions queryOptions)
                                                   throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get total number of SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state for the specific supervisor

Specified by:

getNumberOfFailedProcessInstancesSupervisedBy in interface ProcessInstanceService

Parameters:

userId - identifier of supervisor user

queryOptions - a map of specific parameters of a query

Returns:

The number of the SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state for the specific supervisor

Throws:

SBonitaReadException

searchFailedProcessInstancesSupervisedBy

public java.util.List<SProcessInstance> searchFailedProcessInstancesSupervisedBy(long userId,
                                                                                 QueryOptions queryOptions)
                                                                          throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Search all SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state for the specific supervisor

Specified by:

searchFailedProcessInstancesSupervisedBy in interface ProcessInstanceService

Parameters:

userId - identifier of supervisor user

queryOptions - a map of specific parameters of a query

Returns:

The list of SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state for the specific supervisor

Throws:

SBonitaReadException

getNumberOfOpenProcessInstancesInvolvingUser

public long getNumberOfOpenProcessInstancesInvolvingUser(long userId,
                                                         QueryOptions queryOptions)
                                                  throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get total number of open process instance involving the specific user

Specified by:

getNumberOfOpenProcessInstancesInvolvingUser in interface ProcessInstanceService

Parameters:

userId - identifier of user who can perform or be assigned to tasks in process instance.

queryOptions - a map of specific parameters of a query

Returns:

number of open process instance for the specific user

Throws:

SBonitaReadException

searchOpenProcessInstancesInvolvingUser

public java.util.List<SProcessInstance> searchOpenProcessInstancesInvolvingUser(long userId,
                                                                                QueryOptions queryOptions)
                                                                         throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Search all open process instance involving the specific user

Specified by:

searchOpenProcessInstancesInvolvingUser in interface ProcessInstanceService

Parameters:

userId - identifier of user who can perform or be assigned to tasks in process instance.

Returns:

a list of SProcessInstance objects

Throws:

SBonitaReadException

getNumberOfOpenProcessInstancesInvolvingUsersManagedBy

public long getNumberOfOpenProcessInstancesInvolvingUsersManagedBy(long managerUserId,
                                                                   QueryOptions queryOptions)
                                                            throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get total number of open process instance involving all users of the specific manager

Specified by:

getNumberOfOpenProcessInstancesInvolvingUsersManagedBy in interface ProcessInstanceService

Returns:

Throws:

SBonitaReadException

searchOpenProcessInstancesInvolvingUsersManagedBy

public java.util.List<SProcessInstance> searchOpenProcessInstancesInvolvingUsersManagedBy(long managerUserId,
                                                                                          QueryOptions queryOptions)
                                                                                   throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Search all open process instance involving all users of the specific manager

Specified by:

searchOpenProcessInstancesInvolvingUsersManagedBy in interface ProcessInstanceService

Returns:

Throws:

SBonitaReadException

getNumberOfArchivedProcessInstancesWithoutSubProcess

public long getNumberOfArchivedProcessInstancesWithoutSubProcess(QueryOptions queryOptions)
                                                          throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get total number of archived process instance according to the search criteria

Specified by:

getNumberOfArchivedProcessInstancesWithoutSubProcess in interface ProcessInstanceService

Parameters:

queryOptions - the search criteria containing a map of specific parameters of a query

Returns:

number of archived process instance satisfied to the search criteria

Throws:

SBonitaReadException

searchArchivedProcessInstancesWithoutSubProcess

public java.util.List<SAProcessInstance> searchArchivedProcessInstancesWithoutSubProcess(QueryOptions queryOptions)
                                                                                  throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Search all archived process instance according to the search criteria

Specified by:

searchArchivedProcessInstancesWithoutSubProcess in interface ProcessInstanceService

Parameters:

queryOptions - the search criteria containing a map of specific parameters of a query

Returns:

a list of SAProcessInstance objects

Throws:

SBonitaReadException

searchArchivedProcessInstancesSupervisedBy

public java.util.List<SAProcessInstance> searchArchivedProcessInstancesSupervisedBy(long userId,
                                                                                    QueryOptions queryOptions)
                                                                             throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Search all archived process instance for the specific supervisor

Specified by:

searchArchivedProcessInstancesSupervisedBy in interface ProcessInstanceService

Parameters:

userId - identifier of user who is the supervisor of archived process instance.

queryOptions - the search criteria containing a map of specific parameters of a query

Returns:

a list of SAProcessInstance objects

Throws:

SBonitaReadException

getNumberOfArchivedProcessInstancesSupervisedBy

public long getNumberOfArchivedProcessInstancesSupervisedBy(long userId,
                                                            QueryOptions countOptions)
                                                     throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get total number of archived process instance for the specific supervisor

Specified by:

getNumberOfArchivedProcessInstancesSupervisedBy in interface ProcessInstanceService

Parameters:

userId - identifier of user who is the supervisor of archived process instance.

countOptions - the search criteria containing a map of specific parameters of a query

Returns:

number of archived process instance for the specific supervisor

Throws:

SBonitaReadException

getNumberOfArchivedProcessInstancesInvolvingUser

public long getNumberOfArchivedProcessInstancesInvolvingUser(long userId,
                                                             QueryOptions countOptions)
                                                      throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get total number of archived process instance involving the specific user

Specified by:

getNumberOfArchivedProcessInstancesInvolvingUser in interface ProcessInstanceService

Parameters:

userId - the identifier of user who is assignee of tasks of process instance

countOptions - the search criteria containing a map of specific parameters of a query

Returns:

number of archived process instance involving the specific user

Throws:

SBonitaReadException

getNumberOfArchivedProcessInstances

public long getNumberOfArchivedProcessInstances(QueryOptions queryOptions)
                                         throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get total number of archived process instances according to specific criteria

Specified by:

getNumberOfArchivedProcessInstances in interface ProcessInstanceService

Parameters:

queryOptions - the search criteria containing a map of specific parameters of a query

Returns:

number of archived process instances

Throws:

SBonitaReadException

searchArchivedProcessInstances

public java.util.List<SAProcessInstance> searchArchivedProcessInstances(QueryOptions queryOptions)
                                                                 throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Search all archived process instance according to specific criteria

Specified by:

searchArchivedProcessInstances in interface ProcessInstanceService

Parameters:

queryOptions - the search criteria containing a map of specific parameters of a query

Returns:

A list of all archived process instance according to specific criteria

Throws:

SBonitaReadException

searchArchivedProcessInstancesInvolvingUser

public java.util.List<SAProcessInstance> searchArchivedProcessInstancesInvolvingUser(long userId,
                                                                                     QueryOptions queryOptions)
                                                                              throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Search all archived process instance involving the specific user

Specified by:

searchArchivedProcessInstancesInvolvingUser in interface ProcessInstanceService

Parameters:

userId - the identifier of user who is assignee of tasks of process instance

queryOptions - the search criteria containing a map of specific parameters of a query

Returns:

a list of SAProcessInstance objects

Throws:

SBonitaReadException

updateProcess

public void updateProcess(SProcessInstance processInstance,
                          EntityUpdateDescriptor descriptor)
                   throws SProcessInstanceModificationException

Description copied from interface: ProcessInstanceService

Update the specific process instance

Specified by:

updateProcess in interface ProcessInstanceService

Parameters:

processInstance - the processInstance will be updated

descriptor - update description

Throws:

SProcessInstanceModificationException

getArchivedProcessInstance

public SAProcessInstance getArchivedProcessInstance(long archivedProcessInstanceId)
                                             throws SProcessInstanceReadException

Description copied from interface: ProcessInstanceService

Get the latest archived process instance object for the specific process instance

Specified by:

getArchivedProcessInstance in interface ProcessInstanceService

Parameters:

archivedProcessInstanceId - identifier of the archived process instance (not the process instance)

Returns:

an SAProcessInstance object

Throws:

SProcessInstanceReadException

getArchivedProcessInstancesInAllStates

public java.util.List<SAProcessInstance> getArchivedProcessInstancesInAllStates(java.util.List<java.lang.Long> processInstanceIds)
                                                                         throws SProcessInstanceReadException

Description copied from interface: ProcessInstanceService

Get the archived process instances corresponding to the identifiers

Specified by:

getArchivedProcessInstancesInAllStates in interface ProcessInstanceService

Returns:

The list of SAProcessInstance

Throws:

SProcessInstanceReadException

getStateIdsFromStates

protected java.util.Set<java.lang.Integer> getStateIdsFromStates(org.bonitasoft.engine.bpm.process.ProcessInstanceState... states)

getArchivedChildrenSourceObjectIdsFromRootProcessInstance

public java.util.List<java.lang.Long> getArchivedChildrenSourceObjectIdsFromRootProcessInstance(long rootProcessInstanceId,
                                                                                                int fromIndex,
                                                                                                int maxResults,
                                                                                                OrderByType sortingOrder)
                                                                                         throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get the list of sourceObjectIds for archived process instances children of process instance identified by rootProcessIntanceId

Specified by:

getArchivedChildrenSourceObjectIdsFromRootProcessInstance in interface ProcessInstanceService

Parameters:

rootProcessInstanceId - the root process instance id

fromIndex - index of first result to be retried

maxResults - max number of results to be retrieved

sortingOrder - the searching order (ASC or DESC)

Returns:

the list of sourceObjectIds for archived process instances children of process instance identified by rootProcessIntanceId

Throws:

SBonitaReadException

getLastArchivedProcessInstance

public SAProcessInstance getLastArchivedProcessInstance(long processInstanceId)
                                                 throws SBonitaReadException

Specified by:

getLastArchivedProcessInstance in interface ProcessInstanceService

Parameters:

processInstanceId - The source identifier of the process instance

Returns:

The last archived process instance

Throws:

SBonitaReadException

getNumberOfFailedProcessInstances

public long getNumberOfFailedProcessInstances(QueryOptions queryOptions)
                                       throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Get the number of the SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state.

Specified by:

getNumberOfFailedProcessInstances in interface ProcessInstanceService

Parameters:

queryOptions - the search criteria containing a map of specific parameters of a query

Returns:

The number of the SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state.

Throws:

SBonitaReadException

searchFailedProcessInstances

public java.util.List<SProcessInstance> searchFailedProcessInstances(QueryOptions queryOptions)
                                                              throws SBonitaReadException

Description copied from interface: ProcessInstanceService

List all SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state.

Specified by:

searchFailedProcessInstances in interface ProcessInstanceService

Parameters:

queryOptions - the search criteria containing a map of specific parameters of a query

Returns:

The list of SProcessInstance with at least one failed task or the ProcessInstanceState.ERROR state.

Throws:

SBonitaReadException

getNumberOfProcessInstances

public long getNumberOfProcessInstances(long processDefinitionId)
                                 throws SBonitaReadException

Specified by:

getNumberOfProcessInstances in interface ProcessInstanceService

Throws:

SBonitaReadException

getProcessInstanceIdsToRecover

public java.util.List<java.lang.Long> getProcessInstanceIdsToRecover(java.time.Duration considerElementsOlderThan,
                                                                     QueryOptions queryOptions)
                                                              throws SBonitaReadException

Description copied from interface: ProcessInstanceService

Retrieve ids of process instances nodes that needs to be recovered. This is used by recover mechanism ProcessInstanceRecoveryService

Specified by:

getProcessInstanceIdsToRecover in interface ProcessInstanceService

Parameters:

considerElementsOlderThan - consider elements older than that duration

queryOptions - used for pagination

Throws:

SBonitaReadException

setInterruptingEventId

public void setInterruptingEventId(long parentProcessInstanceId,
                                   long eventInstanceId)
                            throws SProcessInstanceNotFoundException,
                                   SProcessInstanceReadException,
                                   SProcessInstanceModificationException

Description copied from interface: ProcessInstanceService

Set which event interrupted the process instance

Specified by:

setInterruptingEventId in interface ProcessInstanceService

Throws:

SProcessInstanceNotFoundException

SProcessInstanceReadException

SProcessInstanceModificationException