RuntimeService (camunda BPM - engine 7.9.0-alpha1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.camunda.bpm.engine
Interface RuntimeService

All Known Implementing Classes:: RuntimeServiceImpl

public interface RuntimeService

Service which provides access to Deployments, ProcessDefinitions and ProcessInstances.

Author:: Tom Baeyens, Joram Barrez, Daniel Meyer

Method Summary

void activateProcessInstanceById(String processInstanceId)
Activates the process instance with the given id.

void activateProcessInstanceByProcessDefinitionId(String processDefinitionId)
Activates the process instance with the given process definition id.

void activateProcessInstanceByProcessDefinitionKey(String processDefinitionKey)
Activates the process instance with the given process definition key.

void correlateMessage(String messageName)
Correlates a message to either an execution that is waiting for this message or a process definition that can be started by this message.

void correlateMessage(String messageName, Map<String,Object> correlationKeys)
Correlates a message to an execution that is waiting for a matching message and can be correlated according to the given correlation keys.

void correlateMessage(String messageName, Map<String,Object> correlationKeys, Map<String,Object> processVariables)
Correlates a message to an execution that is waiting for a matching message and can be correlated according to the given correlation keys.

void correlateMessage(String messageName, String businessKey)
Correlates a message to an execution that is waiting for a matching message and belongs to a process instance with the given business key a process definition that can be started by a matching message.

void correlateMessage(String messageName, String businessKey, Map<String,Object> processVariables)
Correlates a message to an execution that is waiting for a matching message and belongs to a process instance with the given business key a process definition that can be started by this message.

void correlateMessage(String messageName, String businessKey, Map<String,Object> correlationKeys, Map<String,Object> processVariables)
Correlates a message to an execution that is waiting for a matching message and can be correlated according to the given correlation keys.

ConditionEvaluationBuilder createConditionEvaluation()
Define a complex condition evaluation using a fluent builder.

EventSubscriptionQuery createEventSubscriptionQuery()
Creates a new EventSubscriptionQuery instance, that can be used to query event subscriptions.

ExecutionQuery createExecutionQuery()
Creates a new ExecutionQuery instance, that can be used to query the executions and process instances.

Incident createIncident(String incidentType, String executionId, String configuration)
Creates an incident

Incident createIncident(String incidentType, String executionId, String configuration, String message)
Creates an incident

IncidentQuery createIncidentQuery()
Creates a new IncidentQuery instance, that can be used to query incidents.

MessageCorrelationBuilder createMessageCorrelation(String messageName)
Define a complex message correlation using a fluent builder.

MigrationPlanBuilder createMigrationPlan(String sourceProcessDefinitionId, String targetProcessDefinitionId)
Creates a migration plan to migrate process instance between different process definitions.

ModificationBuilder createModification(String processDefinitionId)
Creates a modification of multiple process instances in terms of activity cancellations and instantiations via a fluent builder.

NativeExecutionQuery createNativeExecutionQuery()
creates a new NativeExecutionQuery to query Executions by SQL directly

NativeProcessInstanceQuery createNativeProcessInstanceQuery()
creates a new NativeProcessInstanceQuery to query ProcessInstances by SQL directly

ProcessInstantiationBuilder createProcessInstanceById(String processDefinitionId)
Returns a fluent builder to start a new process instance in the exactly specified version of the process definition with the given id.

ProcessInstantiationBuilder createProcessInstanceByKey(String processDefinitionKey)
Returns a fluent builder to start a new process instance in the latest version of the process definition with the given key.

ProcessInstanceModificationBuilder createProcessInstanceModification(String processInstanceId)
Define a modification of a process instance in terms of activity cancellations and instantiations via a fluent builder.

ProcessInstanceQuery createProcessInstanceQuery()
Creates a new ProcessInstanceQuery instance, that can be used to query process instances.

SignalEventReceivedBuilder createSignalEvent(String signalName)
Notifies the process engine that a signal event has been received using a fluent builder.

VariableInstanceQuery createVariableInstanceQuery()
Creates a new VariableInstanceQuery instance, that can be used to query variable instances.

void deleteProcessInstance(String processInstanceId, String deleteReason)
Delete an existing runtime process instance.

void deleteProcessInstance(String processInstanceId, String deleteReason, boolean skipCustomListeners)
Delete an existing runtime process instance.

void deleteProcessInstance(String processInstanceId, String deleteReason, boolean skipCustomListeners, boolean externallyTerminated)
Delete an existing runtime process instance.

void deleteProcessInstance(String processInstanceId, String deleteReason, boolean skipCustomListeners, boolean externallyTerminated, boolean skipIoMappings)
Delete an existing runtime process instance.

void deleteProcessInstance(String processInstanceId, String deleteReason, boolean skipCustomListeners, boolean externallyTerminated, boolean skipIoMappings, boolean skipSubprocesses)
Delete an existing runtime process instance.

void deleteProcessInstances(List<String> processInstanceIds, String deleteReason, boolean skipCustomListeners, boolean externallyTerminated)
Delete existing runtime process instances.

void deleteProcessInstances(List<String> processInstanceIds, String deleteReason, boolean skipCustomListeners, boolean externallyTerminated, boolean skipSubprocesses)
Delete existing runtime process instances.

Batch deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, String deleteReason)
Delete an existing runtime process instances asynchronously using Batch operation.

Batch deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, String deleteReason, boolean skipCustomListeners)
Delete an existing runtime process instances asynchronously using Batch operation.

Batch deleteProcessInstancesAsync(List<String> processInstanceIds, ProcessInstanceQuery processInstanceQuery, String deleteReason, boolean skipCustomListeners, boolean skipSubprocesses)
Delete an existing runtime process instances asynchronously using Batch operation.

Batch deleteProcessInstancesAsync(List<String> processInstanceIds, String deleteReason)
Delete an existing runtime process instances asynchronously using Batch operation.

Batch deleteProcessInstancesAsync(ProcessInstanceQuery processInstanceQuery, String deleteReason)
Delete an existing runtime process instances asynchronously using Batch operation.

List<String> getActiveActivityIds(String executionId)
Finds the activity ids for all executions that are waiting in activities.

ActivityInstance getActivityInstance(String processInstanceId)
Allows retrieving the activity instance tree for a given process instance.

Object getVariable(String executionId, String variableName)
The variable value.

Object getVariableLocal(String executionId, String variableName)
The variable value for an execution.





<T extends org.camunda.bpm.engine.variable.value.TypedValue> 


T

getVariableLocalTyped(String executionId,
                      String variableName)

Returns a TypedValue for the variable.





<T extends org.camunda.bpm.engine.variable.value.TypedValue> 


T

getVariableLocalTyped(String executionId,
                      String variableName,
                      boolean deserializeValue)

Returns a TypedValue for the variable.

Map<String,Object> getVariables(String executionId)
All variables visible from the given execution scope (including parent scopes).

Map<String,Object> getVariables(String executionId, Collection<String> variableNames)
The variable values for all given variableNames, takes all variables into account which are visible from the given execution scope (including parent scopes).

Map<String,Object> getVariablesLocal(String executionId)
All variable values that are defined in the execution scope, without taking outer scopes into account.

Map<String,Object> getVariablesLocal(String executionId, Collection<String> variableNames)
The variable values for the given variableNames only taking the given execution scope into account, not looking in outer scopes.

org.camunda.bpm.engine.variable.VariableMap getVariablesLocalTyped(String executionId)
All variable values that are defined in the execution scope, without taking outer scopes into account.

org.camunda.bpm.engine.variable.VariableMap getVariablesLocalTyped(String executionId, boolean deserializeValues)
All variable values that are defined in the execution scope, without taking outer scopes into account.

org.camunda.bpm.engine.variable.VariableMap getVariablesLocalTyped(String executionId, Collection<String> variableNames, boolean deserializeValues)
The variable values for the given variableNames only taking the given execution scope into account, not looking in outer scopes.

org.camunda.bpm.engine.variable.VariableMap getVariablesTyped(String executionId)
All variables visible from the given execution scope (including parent scopes).

org.camunda.bpm.engine.variable.VariableMap getVariablesTyped(String executionId, boolean deserializeValues)
All variables visible from the given execution scope (including parent scopes).

org.camunda.bpm.engine.variable.VariableMap getVariablesTyped(String executionId, Collection<String> variableNames, boolean deserializeValues)
The variable values for all given variableNames, takes all variables into account which are visible from the given execution scope (including parent scopes).





<T extends org.camunda.bpm.engine.variable.value.TypedValue> 


T

getVariableTyped(String executionId,
                 String variableName)

Returns a TypedValue for the variable.





<T extends org.camunda.bpm.engine.variable.value.TypedValue> 


T

getVariableTyped(String executionId,
                 String variableName,
                 boolean deserializeValue)

Returns a TypedValue for the variable.

void messageEventReceived(String messageName, String executionId)
Notifies the process engine that a message event with name 'messageName' has been received and has been correlated to an execution with id 'executionId'.

void messageEventReceived(String messageName, String executionId, Map<String,Object> processVariables)
Notifies the process engine that a message event with the name 'messageName' has been received and has been correlated to an execution with id 'executionId'.

MigrationPlanExecutionBuilder newMigration(MigrationPlan migrationPlan)
Executes a migration plan for a given list of process instances.

void removeVariable(String executionId, String variableName)
Removes a variable for an execution.

void removeVariableLocal(String executionId, String variableName)
Removes a variable for an execution (not considering parent scopes).

void removeVariables(String executionId, Collection<String> variableNames)
Removes variables for an execution.

void removeVariablesLocal(String executionId, Collection<String> variableNames)
Remove variables for an execution (not considering parent scopes).

void resolveIncident(String incidentId)
Resolves and remove an incident

RestartProcessInstanceBuilder restartProcessInstances(String processDefinitionId)
Restarts process instances that are completed or deleted with the initial or last set of variables.

void setVariable(String executionId, String variableName, Object value)
Update or create a variable for an execution.

void setVariableLocal(String executionId, String variableName, Object value)
Update or create a variable for an execution (not considering parent scopes).

void setVariables(String executionId, Map<String,? extends Object> variables)
Update or create given variables for an execution (including parent scopes).

void setVariablesLocal(String executionId, Map<String,? extends Object> variables)
Update or create given variables for an execution (not considering parent scopes).

void signal(String executionId)
Sends an external trigger to an activity instance that is waiting inside the given execution.

void signal(String executionId, Map<String,Object> processVariables)
Sends an external trigger to an activity instance that is waiting inside the given execution.

void signal(String executionId, String signalName, Object signalData, Map<String,Object> processVariables)
Sends an external trigger to an activity instance that is waiting inside the given execution.

void signalEventReceived(String signalName)
Notifies the process engine that a signal event of name 'signalName' has been received.

void signalEventReceived(String signalName, Map<String,Object> processVariables)
Notifies the process engine that a signal event of name 'signalName' has been received.

void signalEventReceived(String signalName, String executionId)
Notifies the process engine that a signal event of name 'signalName' has been received.

void signalEventReceived(String signalName, String executionId, Map<String,Object> processVariables)
Notifies the process engine that a signal event of name 'signalName' has been received.

ProcessInstance startProcessInstanceById(String processDefinitionId)
Starts a new process instance in the exactly specified version of the process definition with the given id.

ProcessInstance startProcessInstanceById(String processDefinitionId, Map<String,Object> variables)
Starts a new process instance in the exactly specified version of the process definition with the given id.

ProcessInstance startProcessInstanceById(String processDefinitionId, String businessKey)
Starts a new process instance in the exactly specified version of the process definition with the given id.

ProcessInstance startProcessInstanceById(String processDefinitionId, String businessKey, Map<String,Object> variables)
Starts a new process instance in the exactly specified version of the process definition with the given id.

ProcessInstance startProcessInstanceById(String processDefinitionId, String businessKey, String caseInstanceId)
Starts a new process instance in the exactly specified version of the process definition with the given id.

ProcessInstance startProcessInstanceById(String processDefinitionId, String businessKey, String caseInstanceId, Map<String,Object> variables)
Starts a new process instance in the exactly specified version of the process definition with the given id.

ProcessInstance startProcessInstanceByKey(String processDefinitionKey)
Starts a new process instance in the latest version of the process definition with the given key.

ProcessInstance startProcessInstanceByKey(String processDefinitionKey, Map<String,Object> variables)
Starts a new process instance in the latest version of the process definition with the given key

ProcessInstance startProcessInstanceByKey(String processDefinitionKey, String businessKey)
Starts a new process instance in the latest version of the process definition with the given key.

ProcessInstance startProcessInstanceByKey(String processDefinitionKey, String businessKey, Map<String,Object> variables)
Starts a new process instance in the latest version of the process definition with the given key.

ProcessInstance startProcessInstanceByKey(String processDefinitionKey, String businessKey, String caseInstanceId)
Starts a new process instance in the latest version of the process definition with the given key.

ProcessInstance startProcessInstanceByKey(String processDefinitionKey, String businessKey, String caseInstanceId, Map<String,Object> variables)
Starts a new process instance in the latest version of the process definition with the given key.

ProcessInstance startProcessInstanceByMessage(String messageName)
Signals the process engine that a message is received and starts a new ProcessInstance.

ProcessInstance startProcessInstanceByMessage(String messageName, Map<String,Object> processVariables)
Signals the process engine that a message is received and starts a new ProcessInstance.

ProcessInstance startProcessInstanceByMessage(String messageName, String businessKey)
Signals the process engine that a message is received and starts a new ProcessInstance.

ProcessInstance startProcessInstanceByMessage(String messageName, String businessKey, Map<String,Object> processVariables)
Signals the process engine that a message is received and starts a new ProcessInstance.

ProcessInstance startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId)
Signals the process engine that a message is received and starts a new ProcessInstance.

ProcessInstance startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId, Map<String,Object> processVariables)
Signals the process engine that a message is received and starts a new ProcessInstance.

ProcessInstance startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId, String businessKey)
Signals the process engine that a message is received and starts a new ProcessInstance.

ProcessInstance startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId, String businessKey, Map<String,Object> processVariables)
Signals the process engine that a message is received and starts a new ProcessInstance.

void suspendProcessInstanceById(String processInstanceId)
Suspends the process instance with the given id.

void suspendProcessInstanceByProcessDefinitionId(String processDefinitionId)
Suspends the process instances with the given process definition id.

void suspendProcessInstanceByProcessDefinitionKey(String processDefinitionKey)
Suspends the process instances with the given process definition key.

UpdateProcessInstanceSuspensionStateSelectBuilder updateProcessInstanceSuspensionState()
Activate or suspend process instances using a fluent builder.

Method Detail

startProcessInstanceByKey

ProcessInstance startProcessInstanceByKey(String processDefinitionKey)

Starts a new process instance in the latest version of the process definition with the given key.

Parameters:: processDefinitionKey - key of process definition, cannot be null.
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceByKey

ProcessInstance startProcessInstanceByKey(String processDefinitionKey,
                                          String businessKey)

Starts a new process instance in the latest version of the process definition with the given key. A business key can be provided to associate the process instance with a certain identifier that has a clear business meaning. For example in an order process, the business key could be an order id. This business key can then be used to easily look up that process instance , see ProcessInstanceQuery.processInstanceBusinessKey(String). Providing such a business key is definitely a best practice. Note that a business key MUST be unique for the given process definition WHEN you have added a database constraint for it. In this case, only Process instance from different process definition are allowed to have the same business key and the combination of processdefinitionKey-businessKey must be unique.

Parameters:: processDefinitionKey - key of process definition, cannot be null.; businessKey - a key that uniquely identifies the process instance in the context of the given process definition.
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceByKey

ProcessInstance startProcessInstanceByKey(String processDefinitionKey,
                                          String businessKey,
                                          String caseInstanceId)

Parameters:: processDefinitionKey - key of process definition, cannot be null.; businessKey - a key that uniquely identifies the process instance in the context of the given process definition.; caseInstanceId - an id of a case instance to associate the process instance with a case instance.
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceByKey

ProcessInstance startProcessInstanceByKey(String processDefinitionKey,
                                          Map<String,Object> variables)

Starts a new process instance in the latest version of the process definition with the given key

Parameters:: processDefinitionKey - key of process definition, cannot be null.; variables - the variables to pass, can be null.
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceByKey

ProcessInstance startProcessInstanceByKey(String processDefinitionKey,
                                          String businessKey,
                                          Map<String,Object> variables)

Parameters:: processDefinitionKey - key of process definition, cannot be null.; variables - the variables to pass, can be null.; businessKey - a key that uniquely identifies the process instance in the context of the given process definition.
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceByKey

ProcessInstance startProcessInstanceByKey(String processDefinitionKey,
                                          String businessKey,
                                          String caseInstanceId,
                                          Map<String,Object> variables)

Parameters:: processDefinitionKey - key of process definition, cannot be null.; variables - the variables to pass, can be null.; businessKey - a key that uniquely identifies the process instance in the context of the given process definition.; caseInstanceId - an id of a case instance to associate the process instance with a case instance.
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceById

ProcessInstance startProcessInstanceById(String processDefinitionId)

Starts a new process instance in the exactly specified version of the process definition with the given id.

Parameters:: processDefinitionId - the id of the process definition, cannot be null.
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceById

ProcessInstance startProcessInstanceById(String processDefinitionId,
                                         String businessKey)

Starts a new process instance in the exactly specified version of the process definition with the given id. A business key can be provided to associate the process instance with a certain identifier that has a clear business meaning. For example in an order process, the business key could be an order id. This business key can then be used to easily look up that process instance , see ProcessInstanceQuery.processInstanceBusinessKey(String). Providing such a business key is definitely a best practice. Note that a business key MUST be unique for the given process definition WHEN you have added a database constraint for it. In this case, only Process instance from different process definition are allowed to have the same business key and the combination of processdefinitionKey-businessKey must be unique.

Parameters:: processDefinitionId - the id of the process definition, cannot be null.; businessKey - a key that uniquely identifies the process instance in the context of the given process definition.
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceById

ProcessInstance startProcessInstanceById(String processDefinitionId,
                                         String businessKey,
                                         String caseInstanceId)

Parameters:: processDefinitionId - the id of the process definition, cannot be null.; businessKey - a key that uniquely identifies the process instance in the context of the given process definition.; caseInstanceId - an id of a case instance to associate the process instance with a case instance.
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceById

ProcessInstance startProcessInstanceById(String processDefinitionId,
                                         Map<String,Object> variables)

Starts a new process instance in the exactly specified version of the process definition with the given id.

Parameters:: processDefinitionId - the id of the process definition, cannot be null.; variables - variables to be passed, can be null
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceById

ProcessInstance startProcessInstanceById(String processDefinitionId,
                                         String businessKey,
                                         Map<String,Object> variables)

Parameters:: processDefinitionId - the id of the process definition, cannot be null.; businessKey - a key that uniquely identifies the process instance in the context of the given process definition.; variables - variables to be passed, can be null
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

startProcessInstanceById

ProcessInstance startProcessInstanceById(String processDefinitionId,
                                         String businessKey,
                                         String caseInstanceId,
                                         Map<String,Object> variables)

Parameters:: processDefinitionId - the id of the process definition, cannot be null.; businessKey - a key that uniquely identifies the process instance in the context of the given process definition.; caseInstanceId - an id of a case instance to associate the process instance with a case instance.; variables - variables to be passed, can be null
Throws:: ProcessEngineException - when no process definition is deployed with the given key.; AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.