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

Interface ProcessInstanceService

All Known Implementing Classes:

ProcessInstanceService7_7_4, ProcessInstanceServiceImpl

public interface ProcessInstanceService

Since:

6.0

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EVENT_TRIGGER_INSTANCE
static java.lang.String	PROCESS_INSTANCE_CATEGORY_STATE
static java.lang.String	PROCESSINSTANCE
static java.lang.String	PROCESSINSTANCE_STATE
static java.lang.String	PROCESSINSTANCE_STATE_UPDATED
static java.lang.String	PROCESSINSTANCE_TOKEN_COUNT

Method Summary

Modifier and Type	Method	Description
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.
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 processInstance)	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 processInstance)	Delete the specified process instance
java.util.List<java.lang.Long>	getArchivedChildrenSourceObjectIdsFromRootProcessInstance(long rootProcessIntanceId, 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 sourceObjectProcessInstanceId)
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)
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

Field Detail

PROCESSINSTANCE

static final java.lang.String PROCESSINSTANCE

See Also:

Constant Field Values

PROCESSINSTANCE_STATE

static final java.lang.String PROCESSINSTANCE_STATE

See Also:

Constant Field Values

PROCESS_INSTANCE_CATEGORY_STATE

static final java.lang.String PROCESS_INSTANCE_CATEGORY_STATE

See Also:

Constant Field Values

PROCESSINSTANCE_STATE_UPDATED

static final java.lang.String PROCESSINSTANCE_STATE_UPDATED

See Also:

Constant Field Values

PROCESSINSTANCE_TOKEN_COUNT

static final java.lang.String PROCESSINSTANCE_TOKEN_COUNT

See Also:

Constant Field Values

EVENT_TRIGGER_INSTANCE

static final java.lang.String EVENT_TRIGGER_INSTANCE

See Also:

Constant Field Values

Method Detail

createProcessInstance

void createProcessInstance(SProcessInstance processInstance)
                    throws SProcessInstanceCreationException

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

Parameters:

processInstance - the processInstance

Throws:

SProcessInstanceCreationException

deleteProcessInstance

void deleteProcessInstance(long processInstanceId)
                    throws SProcessInstanceNotFoundException,
                           SProcessInstanceReadException,
                           SFlowNodeReadException,
                           SProcessInstanceModificationException,
                           SProcessInstanceHierarchicalDeletionException

Delete the id specified process instance

Parameters:

processInstanceId - identifier of process instance

Throws:

SProcessInstanceNotFoundException

SProcessInstanceReadException

SFlowNodeReadException

SProcessInstanceModificationException

SProcessInstanceHierarchicalDeletionException

deleteProcessInstance

void deleteProcessInstance(SProcessInstance processInstance)
                    throws SFlowNodeReadException,
                           SProcessInstanceModificationException,
                           SProcessInstanceHierarchicalDeletionException

Delete the specified process instance

Parameters:

processInstance - the process instance

Throws:

SFlowNodeReadException

SProcessInstanceModificationException

SProcessInstanceHierarchicalDeletionException

Since:

6.0

deleteParentProcessInstanceAndElements

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

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

Parameters:

sProcessInstances - list of process instances to deleted

Returns:

Number of deleted process instances

Throws:

SBonitaException

Since:

6.1

deleteParentProcessInstanceAndElements

void deleteParentProcessInstanceAndElements(SProcessInstance processInstance)
                                     throws SBonitaException

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

Parameters:

processInstance - The SProcessInstance to delete

Throws:

SBonitaException

Since:

6.4.0

getProcessInstance

SProcessInstance getProcessInstance(long processInstanceId)
                             throws SProcessInstanceNotFoundException,
                                    SProcessInstanceReadException

Get process instance by its id

Parameters:

processInstanceId - identifier of process instance

Returns:

the process instance object

Throws:

SProcessInstanceNotFoundException

SProcessInstanceReadException

setState

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

Set state for the processInstance

Parameters:

processInstance - the process instance will be updated

state - the state will be set to the process instance

Throws:

SProcessInstanceNotFoundException

SProcessInstanceModificationException

setStateCategory

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

Set process state category for the given process instance

Parameters:

processInstance - process instance to update

stateCatetory - new category state for the process instance

Throws:

SProcessInstanceNotFoundException

SProcessInstanceModificationException

Since:

6.0

setInterruptingEventId

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

Set which event interrupted the process instance

Throws:

SProcessInstanceNotFoundException

SProcessInstanceReadException

SProcessInstanceModificationException

deleteArchivedProcessInstance

void deleteArchivedProcessInstance(SAProcessInstance archivedProcessInstance)
                            throws SProcessInstanceModificationException,
                                   SFlowNodeReadException

Delete specified archived process instance

Parameters:

archivedProcessInstance - the archived process instance

Throws:

SProcessInstanceModificationException

SFlowNodeReadException

Since:

6.0

deleteArchivedProcessInstances

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

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.

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

getChildInstanceIdsOfProcessInstance

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

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

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

SProcessInstance getChildOfActivity(long activityInstId)
                             throws SProcessInstanceNotFoundException,
                                    SBonitaReadException

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

Parameters:

activityInstId - identifier of call activity or subprocess activity

Returns:

an SProcessInstance object

Throws:

SProcessInstanceNotFoundException

SBonitaReadException

getNumberOfChildInstancesOfProcessInstance

long getNumberOfChildInstancesOfProcessInstance(long processInstanceId)
                                         throws SProcessInstanceReadException

Get total number of child instance for specific process instance

Parameters:

processInstanceId - identifier of process instance

Returns:

number of child instance for the process instance

Throws:

SProcessInstanceReadException

getArchivedProcessInstancesInAllStates

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

Get the archived process instances corresponding to the identifiers

Parameters:

archivedProcessInstanceIds - Identifier of the SAProcessInstances

Returns:

The list of SAProcessInstance

Throws:

SProcessInstanceReadException

Since:

6.4.0

getNumberOfArchivedProcessInstances

long getNumberOfArchivedProcessInstances(QueryOptions queryOptions)
                                  throws SBonitaReadException

Get total number of archived process instances according to specific criteria

Parameters:

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

Returns:

number of archived process instances

Throws:

SBonitaReadException

searchArchivedProcessInstances

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

Search all archived process instance according to specific criteria

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

getArchivedProcessInstance

SAProcessInstance getArchivedProcessInstance(long archivedProcessInstanceId)
                                      throws SProcessInstanceReadException

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

Parameters:

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

persistenceService -

Returns:

an SAProcessInstance object

Throws:

SProcessInstanceReadException

getNumberOfProcessInstances

long getNumberOfProcessInstances(QueryOptions queryOptions)
                          throws SBonitaReadException

Get total number of process instances

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

total number of process instances

Throws:

SBonitaReadException

searchProcessInstances

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

Search all process instance according to specific criteria

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

a list of SProcessInstance objects

Throws:

SBonitaReadException

getNumberOfOpenProcessInstancesSupervisedBy

long getNumberOfOpenProcessInstancesSupervisedBy(long userId,
                                                 QueryOptions queryOptions)
                                          throws SBonitaReadException

Get total number of open process instances for the specific supervisor

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

getNumberOfFailedProcessInstancesSupervisedBy

long getNumberOfFailedProcessInstancesSupervisedBy(long userId,
                                                   QueryOptions queryOptions)
                                            throws SBonitaReadException

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

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

Since:

7.0

searchFailedProcessInstancesSupervisedBy

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

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

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

Since:

7.0

searchOpenProcessInstancesSupervisedBy

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

Search all open process instances for the specific supervisor

Parameters:

userId - identifier of supervisor user

queryOptions - a map of specific parameters of a query

Returns:

a list of SProcessInstance objects

Throws:

SBonitaReadException

getNumberOfOpenProcessInstancesInvolvingUser

long getNumberOfOpenProcessInstancesInvolvingUser(long userId,
                                                  QueryOptions queryOptions)
                                           throws SBonitaReadException

Get total number of open process instance involving the specific user

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

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

Search all open process instance involving the specific user

Parameters:

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

queryOptions -

Returns:

a list of SProcessInstance objects

Throws:

SBonitaReadException

getNumberOfOpenProcessInstancesInvolvingUsersManagedBy

long getNumberOfOpenProcessInstancesInvolvingUsersManagedBy(long managerUserId,
                                                            QueryOptions queryOptions)
                                                     throws SBonitaReadException

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

Parameters:

managerUserId -

queryOptions -

Returns:

Throws:

SBonitaReadException

searchOpenProcessInstancesInvolvingUsersManagedBy

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

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

Parameters:

managerUserId -

queryOptions -

Returns:

Throws:

SBonitaReadException

getArchivedChildrenSourceObjectIdsFromRootProcessInstance

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

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

Parameters:

rootProcessIntanceId - 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

Since:

6.0

getNumberOfArchivedProcessInstancesWithoutSubProcess

long getNumberOfArchivedProcessInstancesWithoutSubProcess(QueryOptions queryOptions)
                                                   throws SBonitaReadException

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

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

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

Search all archived process instance according to the search criteria

Parameters:

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

Returns:

a list of SAProcessInstance objects

Throws:

SBonitaReadException

getNumberOfArchivedProcessInstancesSupervisedBy

long getNumberOfArchivedProcessInstancesSupervisedBy(long userId,
                                                     QueryOptions countOptions)
                                              throws SBonitaReadException

Get total number of archived process instance for the specific supervisor

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

searchArchivedProcessInstancesSupervisedBy

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

Search all archived process instance for the specific supervisor

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

getNumberOfArchivedProcessInstancesInvolvingUser

long getNumberOfArchivedProcessInstancesInvolvingUser(long userId,
                                                      QueryOptions countOptions)
                                               throws SBonitaReadException

Get total number of archived process instance involving the specific user

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

searchArchivedProcessInstancesInvolvingUser

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

Search all archived process instance involving the specific user

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

void updateProcess(SProcessInstance processInstance,
                   EntityUpdateDescriptor descriptor)
            throws SProcessInstanceModificationException

Update the specific process instance

Parameters:

processInstance - the processInstance will be updated

descriptor - update description

Throws:

SProcessInstanceModificationException

deleteFlowNodeInstance

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

Parameters:

flowNodeInstance -

processDefinition -

Throws:

SFlowNodeReadException

SProcessInstanceModificationException

getSourceProcessInstanceIdsOfArchProcessInstancesFromDefinition

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

Parameters:

processDefinitionId -

fromIndex -

maxResults -

sortingOrder -

Returns:

Throws:

SProcessInstanceReadException

getLastArchivedProcessInstance

SAProcessInstance getLastArchivedProcessInstance(long sourceObjectProcessInstanceId)
                                          throws SBonitaReadException

Parameters:

sourceObjectProcessInstanceId - The source identifier of the process instance

Returns:

The last archived process instance

Throws:

SBonitaReadException

Since:

6.3

getNumberOfFailedProcessInstances

long getNumberOfFailedProcessInstances(QueryOptions queryOptions)
                                throws SBonitaReadException

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

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:

SBonitaException

SBonitaReadException

Since:

6.4.0

searchFailedProcessInstances

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

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

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:

SBonitaException

SBonitaReadException

Since:

6.4.0

getNumberOfProcessInstances

long getNumberOfProcessInstances(long processDefinitionId)
                          throws SBonitaReadException

Throws:

SBonitaReadException

getProcessInstanceIdsToRecover

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

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

Parameters:

considerElementsOlderThan - consider elements older than that duration

queryOptions - used for pagination

Throws:

SBonitaReadException