Class DefaultProcessInstanceService

java.lang.Object

org.flowable.cmmn.engine.configurator.impl.process.DefaultProcessInstanceService

All Implemented Interfaces:

ProcessInstanceService

public class DefaultProcessInstanceService
extends Object
implements ProcessInstanceService

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected ProcessEngineConfigurationImpl	processEngineConfiguration

Constructor Summary

Constructors

Constructor	Description
DefaultProcessInstanceService(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Summary

Modifier and Type	Method	Description
void	deleteProcessInstance(String processInstanceId)	Deletes the given process instance.
String	generateNewProcessInstanceId()
List<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).
void	handleCaseTaskError(String executionId, BusinessError error)	Propagates an uncaught business error from a child case instance to the parent BPMN execution.
boolean	isHistoryEnabledForProcessDefinitionId(String processDefinitionId)	Checks whether history is enabled for the given process definition id.
boolean	isHistoryEnabledForProcessInstance(String processInstanceId)	Checks whether history is enabled for the given process instance id.
Object	resolveExpression(String executionId, String expressionString)	Resolves the given expression within the context of the passed execution.
String	resolveProcessDefinitionId(String processDefinitionKey, String tenantId, Boolean fallbackToDefaultTenant, String parentDeploymentId)	Resolves the process definition id from the given key and parameters.
String	startProcessInstance(String processDefinitionId, String predefinedProcessInstanceId, String planItemInstanceId, String stageInstanceId, String tenantId, 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).
String	startProcessInstance(String processDefinitionId, String predefinedProcessInstanceId, String stageInstanceId, String tenantId, 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).
void	triggerCaseTask(String executionId, Map<String,Object> variables)	Triggers a case instance that was started by a process instance.

Methods inherited from class Object

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

Field Details

processEngineConfiguration

protected ProcessEngineConfigurationImpl processEngineConfiguration

Constructor Details

DefaultProcessInstanceService

public DefaultProcessInstanceService(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Details

generateNewProcessInstanceId

public String generateNewProcessInstanceId()

Specified by:

generateNewProcessInstanceId in interface ProcessInstanceService

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.

startProcessInstance

public String startProcessInstance(String processDefinitionId,
 String predefinedProcessInstanceId,
 String stageInstanceId,
 String tenantId,
 Map<String,Object> inParametersMap,
 String businessKey,
 Map<String,Object> variableFormVariables,
 FormInfo variableFormInfo,
 String variableFormOutcome)

Description copied from interface: ProcessInstanceService

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

Specified by:

startProcessInstance in interface ProcessInstanceService

startProcessInstance

public String startProcessInstance(String processDefinitionId,
 String predefinedProcessInstanceId,
 String planItemInstanceId,
 String stageInstanceId,
 String tenantId,
 Map<String,Object> inParametersMap,
 String businessKey,
 Map<String,Object> variableFormVariables,
 FormInfo variableFormInfo,
 String variableFormOutcome)

Description copied from interface: ProcessInstanceService

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

Specified by:

startProcessInstance in interface ProcessInstanceService

triggerCaseTask

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

Description copied from interface: ProcessInstanceService

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

Specified by:

triggerCaseTask in interface ProcessInstanceService

handleCaseTaskError

public void handleCaseTaskError(String executionId,
 BusinessError error)

Description copied from interface: ProcessInstanceService

Propagates an uncaught business error from a child case instance to the parent BPMN execution. This triggers BPMN error propagation (boundary error events) on the CaseTask.

Specified by:

handleCaseTaskError in interface ProcessInstanceService

getOutputParametersOfCaseTask

public List<IOParameter> getOutputParametersOfCaseTask(String executionId)

Description copied from interface: ProcessInstanceService

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

Specified by:

getOutputParametersOfCaseTask in interface ProcessInstanceService

resolveProcessDefinitionId

public String resolveProcessDefinitionId(String processDefinitionKey,
 String tenantId,
 Boolean fallbackToDefaultTenant,
 String parentDeploymentId)

Description copied from interface: ProcessInstanceService

Resolves the process definition id from the given key and parameters.

Specified by:

resolveProcessDefinitionId in interface ProcessInstanceService

isHistoryEnabledForProcessDefinitionId

public boolean isHistoryEnabledForProcessDefinitionId(String processDefinitionId)

Description copied from interface: ProcessInstanceService

Checks whether history is enabled for the given process definition id.

Specified by:

isHistoryEnabledForProcessDefinitionId in interface ProcessInstanceService

isHistoryEnabledForProcessInstance

public boolean isHistoryEnabledForProcessInstance(String processInstanceId)

Description copied from interface: ProcessInstanceService

Checks whether history is enabled for the given process instance id.

Specified by:

isHistoryEnabledForProcessInstance in interface ProcessInstanceService

deleteProcessInstance

public void deleteProcessInstance(String processInstanceId)

Description copied from interface: ProcessInstanceService

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

Specified by:

deleteProcessInstance in interface ProcessInstanceService

getVariable

public Object getVariable(String executionId,
 String variableName)

Description copied from interface: ProcessInstanceService

Returns the variable value for a given variable.

Specified by:

getVariable in interface ProcessInstanceService

getVariables

public Map<String,Object> getVariables(String executionId)

Description copied from interface: ProcessInstanceService

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

Specified by:

getVariables in interface ProcessInstanceService

resolveExpression

public Object resolveExpression(String executionId,
 String expressionString)

Description copied from interface: ProcessInstanceService

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

Specified by:

resolveExpression in interface ProcessInstanceService