Package org.flowable.cmmn.engine.impl.process

Interface ProcessInstanceService

public interface ProcessInstanceService

Author:

Joram Barrez

Method Summary

Modifier and Type	Method	Description
void	deleteProcessInstance(String processInstanceId)	Deletes the given process instance.
String	generateNewProcessInstanceId()
List<org.flowable.cmmn.model.IOParameter>	getOutputParametersOfCaseTask(String executionId)	Retrieves the IOParameter out parameters of a case task currently being execution by the given execution.
Object	getVariable(String executionId, String variableName)	Returns the variable value for a given variable.
Map<String,Object>	getVariables(String executionId)	Returns all variables for the given execution (or process instance).
Object	resolveExpression(String executionId, String expression)	Resolves the given expression within the context of the passed execution.
String	startProcessInstanceByKey(String processDefinitionKey, String predefinedProcessInstanceId, String stageInstanceId, String tenantId, Boolean fallbackToDefaultTenant, String parentDeploymentId, Map<String,Object> inParametersMap, String businessKey, Map<String,Object> variableFormVariables, FormInfo variableFormInfo, String variableFormOutcome)	Starts a process instance without a reference to a plan item instance (i.e.
String	startProcessInstanceByKey(String processDefinitionKey, String predefinedProcessInstanceId, String planItemInstanceId, String stageInstanceId, String tenantId, Boolean fallbackToDefaultTenant, String parentDeploymentId, Map<String,Object> inParametersMap, String businessKey, Map<String,Object> variableFormVariables, FormInfo variableFormInfo, String variableFormOutcome)	Starts a process instance with a reference to a plan item instance (i.e.
void	triggerCaseTask(String executionId, Map<String,Object> variables)	Triggers a case instance that was started by a process instance.

Method Detail

generateNewProcessInstanceId

String generateNewProcessInstanceId()

Returns:

A new id that will be used when starting a process instance. This is for example needed to set the bidirectional relation when a case instance starts a process instance through a process task.

startProcessInstanceByKey

String startProcessInstanceByKey(String processDefinitionKey,
                                 String predefinedProcessInstanceId,
                                 String stageInstanceId,
                                 String tenantId,
                                 Boolean fallbackToDefaultTenant,
                                 String parentDeploymentId,
                                 Map<String,Object> inParametersMap,
                                 String businessKey,
                                 Map<String,Object> variableFormVariables,
                                 FormInfo variableFormInfo,
                                 String variableFormOutcome)

Starts a process instance without a reference to a plan item instance (i.e. non-blocking behavior).

startProcessInstanceByKey

String startProcessInstanceByKey(String processDefinitionKey,
                                 String predefinedProcessInstanceId,
                                 String planItemInstanceId,
                                 String stageInstanceId,
                                 String tenantId,
                                 Boolean fallbackToDefaultTenant,
                                 String parentDeploymentId,
                                 Map<String,Object> inParametersMap,
                                 String businessKey,
                                 Map<String,Object> variableFormVariables,
                                 FormInfo variableFormInfo,
                                 String variableFormOutcome)

Starts a process instance with a reference to a plan item instance (i.e. blocking behavior).

deleteProcessInstance

void deleteProcessInstance(String processInstanceId)

Deletes the given process instance. Typically used to propagate termination.

getVariable

Object getVariable(String executionId,
                   String variableName)

Returns the variable value for a given variable.

getVariables

Map<String,Object> getVariables(String executionId)

Returns all variables for the given execution (or process instance).

resolveExpression

Object resolveExpression(String executionId,
                         String expression)

Resolves the given expression within the context of the passed execution.

triggerCaseTask

void triggerCaseTask(String executionId,
                     Map<String,Object> variables)

Triggers a case instance that was started by a process instance.

getOutputParametersOfCaseTask

List<org.flowable.cmmn.model.IOParameter> getOutputParametersOfCaseTask(String executionId)

Retrieves the IOParameter out parameters of a case task currently being execution by the given execution.