RuntimeService (camunda BPM - Release Root 7.0.5-ee API)

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

Methods
Modifier and Type	Method and Description
`void`	`activateProcessInstanceById(String processInstanceId)` Activates the process instance with the given id.
`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 this 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 this 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 this 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> processVariables)` Correlates a message to an execution that is waiting for this 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 this message and can be correlated according to the given correlation keys.
`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.
`IncidentQuery`	`createIncidentQuery()` Creates a new `IncidentQuery` instance, that can be used to query incidents.
`NativeExecutionQuery`	`createNativeExecutionQuery()` creates a new `NativeExecutionQuery` to query `Execution`s by SQL directly
`NativeProcessInstanceQuery`	`createNativeProcessInstanceQuery()` creates a new `NativeProcessInstanceQuery` to query `ProcessInstance`s by SQL directly
`ProcessInstanceQuery`	`createProcessInstanceQuery()` Creates a new `ProcessInstanceQuery` instance, that can be used to query process instances.
`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.
`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.
`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.
`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'.
`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`	`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`	`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`	`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`	`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`.
`void`	`suspendProcessInstanceById(String processInstanceId)` Suspends the process instance with the given id.

- 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.
  - 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.
  - 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.
  - startProcessInstanceByKey
```
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. 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. The combination of processdefinitionKey-businessKey must be unique.
    
    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.
  - 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.
  - 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.
  - 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.
  - startProcessInstanceById
```
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. 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.
    variables - variables to be passed, can be null
    
    Throws:
    
    ProcessEngineException - when no process definition is deployed with the given key.
  - startProcessInstanceByMessage
```
ProcessInstance startProcessInstanceByMessage(String messageName)
```
    Signals the process engine that a message is received and starts a new ProcessInstance.
    
    Calling this method can have two different outcomes:
    - If the message name is associated with a message start event, a new process instance is started.
    - If no subscription to a message with the given name exists, ProcessEngineException is thrown
    Parameters:
    messageName - the 'name' of the message as specified as an attribute on the bpmn20 <message name="messageName" /> element.
    
    Returns:
    the ProcessInstance object representing the started process instance
    
    Throws:
    
    ProcessEngineException - if no subscription to a message with the given name exists
    Since:
    
    5.9
  - startProcessInstanceByMessage
```
ProcessInstance startProcessInstanceByMessage(String messageName,
                                            String businessKey)
```
    Signals the process engine that a message is received and starts a new ProcessInstance.
    See startProcessInstanceByMessage(String, Map). This method allows specifying a business key.
    
    Parameters:
    messageName - the 'name' of the message as specified as an attribute on the bpmn20 <message name="messageName" /> element.
    businessKey - the business key which is added to the started process instance
    
    Throws:
    
    ProcessEngineException - if no subscription to a message with the given name exists
    Since:
    
    5.10
  - startProcessInstanceByMessage
```
ProcessInstance startProcessInstanceByMessage(String messageName,
                                            Map<String,Object> processVariables)
```
    Signals the process engine that a message is received and starts a new ProcessInstance.
    See startProcessInstanceByMessage(String). In addition, this method allows specifying a the payload of the message as a map of process variables.
    
    Parameters:
    messageName - the 'name' of the message as specified as an attribute on the bpmn20 <message name="messageName" /> element.
    processVariables - the 'payload' of the message. The variables are added as processes variables to the started process instance.
    
    Returns:
    the ProcessInstance object representing the started process instance
    
    Throws:
    
    ProcessEngineException - if no subscription to a message with the given name exists
    Since:
    
    5.9
  - startProcessInstanceByMessage
```
ProcessInstance startProcessInstanceByMessage(String messageName,
                                            String businessKey,
                                            Map<String,Object> processVariables)
```
    Signals the process engine that a message is received and starts a new ProcessInstance.
    See startProcessInstanceByMessage(String, Map). In addition, this method allows specifying a business key.
    
    Parameters:
    messageName - the 'name' of the message as specified as an attribute on the bpmn20 <message name="messageName" /> element.
    businessKey - the business key which is added to the started process instance
    processVariables - the 'payload' of the message. The variables are added as processes variables to the started process instance.
    
    Returns:
    the ProcessInstance object representing the started process instance
    
    Throws:
    
    ProcessEngineException - if no subscription to a message with the given name exists
    Since:
    
    5.9
  - deleteProcessInstance
```
void deleteProcessInstance(String processInstanceId,
                         String deleteReason)
```
    Delete an existing runtime process instance.
    
    Parameters:
    processInstanceId - id of process instance to delete, cannot be null.
    deleteReason - reason for deleting, can be null.
    
    Throws:
    
    ProcessEngineException - when no process instance is found with the given id.
  - getActiveActivityIds
```
List<String> getActiveActivityIds(String executionId)
```
    Finds the activity ids for all executions that are waiting in activities. This is a list because a single activity can be active multiple times.
    
    Parameters:
    executionId - id of the execution, cannot be null.
    
    Throws:
    
    ProcessEngineException - when no execution exists with the given executionId.
  - getActivityInstance
```
ActivityInstance getActivityInstance(String processInstanceId)
```
    Allows retrieving the activity instance tree for a given process instance. The activity instance tree is aligned with the concept of scope in the BPMN specification. Activities that are "on the same level of subprocess" (ie. part of the same scope, contained in the same subprocess) will have their activity instances at the same level in the tree.
    
    Examples:
    - Process with two parallel user tasks after parallel Gateway: in the activity instance tree you will see two activity instances below the root instance, one for each user task.
    - Process with two parallel Multi Instance user tasks after parallel Gateway: in the activity instance tree, all instances of both user tasks will be listed below the root activity instance. Reason: all activity instances are at the same level of subprocess.
    - Usertask inside embedded subprocess: the activity instance three will have 3 levels: the root instance representing the process instance itself, below it an activity instance representing the instance of the embedded subprocess, and below this one, the activity instance representing the usertask.
    Identity & Uniqueness:
    
    Each activity instance is assigned a unique Id. The id is persistent, if you invoke this method multiple times, the same activity instance ids will be returned for the same activity instances. (However, there might be different executions assigned, see below)
    
    Relation to Executions
    
    The Execution concept in the process engine is not completely aligned with the activity instance concept because the execution tree is in general not aligned with the activity / scope concept in BPMN. In general, there is a n-1 relationship between Executions and ActivityInstances, ie. at a given point in time, an activity instance can be linked to multiple executions. In addition, it is not guaranteed that the same execution that started a given activity instance will also end it. The process engine performs several internal optimizations concerning the compacting of the execution tree which might lead to executions being reordered and pruned. This can lead to situations where a given execution starts an activity instance but another execution ends it. Another special case is the process instance: if the process instance is executing a non-scope activity (for example a user task) below the process definition scope, it will be referenced by both the root activity instance and the user task activity instance.
    If you need to interpret the state of a process instance in terms of a BPMN process model, it is usually easier to use the activity instance tree as opposed to the execution tree.
    Parameters:
    processInstanceId - the id of the process instance for which the activity instance tree should be constructed.
    
    Returns:
    the activity instance tree for a given process instance or null if no such process instance exists.
    
    Throws:
    
    ProcessEngineException - if processInstanceId is 'null' or an internal error occurs.
    Since:
    
    7.0
  - signal
```
void signal(String executionId)
```
    Sends an external trigger to an activity instance that is waiting inside the given execution.
    
    Parameters:
    executionId - id of execution to signal, cannot be null.
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - signal
```
void signal(String executionId,
          Map<String,Object> processVariables)
```
    Sends an external trigger to an activity instance that is waiting inside the given execution.
    
    Parameters:
    executionId - id of execution to signal, cannot be null.
    processVariables - a map of process variables
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - getVariables
```
Map<String,Object> getVariables(String executionId)
```
    All variables visible from the given execution scope (including parent scopes).
    
    Parameters:
    executionId - id of execution, cannot be null.
    
    Returns:
    the variables or an empty map if no such variables are found.
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - getVariablesLocal
```
Map<String,Object> getVariablesLocal(String executionId)
```
    All variable values that are defined in the execution scope, without taking outer scopes into account. If you have many task local variables and you only need a few, consider using getVariablesLocal(String, Collection) for better performance.
    
    Parameters:
    executionId - id of execution, cannot be null.
    
    Returns:
    the variables or an empty map if no such variables are found.
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - getVariables
```
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).
    
    Parameters:
    executionId - id of execution, cannot be null.
    variableNames - the collection of variable names that should be retrieved.
    
    Returns:
    the variables or an empty map if no such variables are found.
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - getVariablesLocal
```
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.
    
    Parameters:
    executionId - id of execution, cannot be null.
    variableNames - the collection of variable names that should be retrieved.
    
    Returns:
    the variables or an empty map if no such variables are found.
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - getVariable
```
Object getVariable(String executionId,
                 String variableName)
```
    The variable value. Searching for the variable is done in all scopes that are visible to the given execution (including parent scopes). Returns null when no variable value is found with the given name or when the value is set to null.
    
    Parameters:
    executionId - id of execution, cannot be null.
    variableName - name of variable, cannot be null.
    
    Returns:
    the variable value or null if the variable is undefined or the value of the variable is null.
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - getVariableLocal
```
Object getVariableLocal(String executionId,
                      String variableName)
```
    The variable value for an execution. Returns the value when the variable is set for the execution (and not searching parent scopes). Returns null when no variable value is found with the given name or when the value is set to null.
  - setVariable
```
void setVariable(String executionId,
               String variableName,
               Object value)
```
    Update or create a variable for an execution. If the variable is not already existing somewhere in the execution hierarchy, it will be created in the process instance (which is the root execution).
    
    Parameters:
    executionId - id of execution to set variable in, cannot be null.
    variableName - name of variable to set, cannot be null.
    value - value to set. When null is passed, the variable is not removed, only it's value will be set to null.
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - setVariableLocal
```
void setVariableLocal(String executionId,
                    String variableName,
                    Object value)
```
    Update or create a variable for an execution (not considering parent scopes). If the variable is not already existing, it will be created in the given execution.
    
    Parameters:
    executionId - id of execution to set variable in, cannot be null.
    variableName - name of variable to set, cannot be null.
    value - value to set. When null is passed, the variable is not removed, only it's value will be set to null.
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - setVariables
```
void setVariables(String executionId,
                Map<String,? extends Object> variables)
```
    Update or create given variables for an execution (including parent scopes). If the variables are not already existing, they will be created in the process instance (which is the root execution).
    
    Parameters:
    executionId - id of the execution, cannot be null.
    variables - map containing name (key) and value of variables, can be null.
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - setVariablesLocal
```
void setVariablesLocal(String executionId,
                     Map<String,? extends Object> variables)
```
    Update or create given variables for an execution (not considering parent scopes). If the variables are not already existing, it will be created in the given execution.
    
    Parameters:
    executionId - id of the execution, cannot be null.
    variables - map containing name (key) and value of variables, can be null.
    
    Throws:
    
    ProcessEngineException - when no execution is found for the given executionId.
  - removeVariable
```
void removeVariable(String executionId,
                  String variableName)
```
    Removes a variable for an execution.
    
    Parameters:
    executionId - id of execution to remove variable in.
    variableName - name of variable to remove.
  - removeVariableLocal
```
void removeVariableLocal(String executionId,
                       String variableName)
```
    Removes a variable for an execution (not considering parent scopes).
    
    Parameters:
    executionId - id of execution to remove variable in.
    variableName - name of variable to remove.
  - removeVariables
```
void removeVariables(String executionId,
                   Collection<String> variableNames)
```
    Removes variables for an execution.
    
    Parameters:
    executionId - id of execution to remove variable in.
    variableNames - collection containing name of variables to remove.
  - removeVariablesLocal
```
void removeVariablesLocal(String executionId,
                        Collection<String> variableNames)
```
    Remove variables for an execution (not considering parent scopes).
    
    Parameters:
    executionId - id of execution to remove variable in.
    variableNames - collection containing name of variables to remove.
  - createExecutionQuery
```
ExecutionQuery createExecutionQuery()
```
    Creates a new ExecutionQuery instance, that can be used to query the executions and process instances.
  - createNativeExecutionQuery
```
NativeExecutionQuery createNativeExecutionQuery()
```
    creates a new NativeExecutionQuery to query Executions by SQL directly
  - createProcessInstanceQuery
```
ProcessInstanceQuery createProcessInstanceQuery()
```
    Creates a new ProcessInstanceQuery instance, that can be used to query process instances.
  - createNativeProcessInstanceQuery
```
NativeProcessInstanceQuery createNativeProcessInstanceQuery()
```
    creates a new NativeProcessInstanceQuery to query ProcessInstances by SQL directly
  - createIncidentQuery
```
IncidentQuery createIncidentQuery()
```
    Creates a new IncidentQuery instance, that can be used to query incidents.
  - createEventSubscriptionQuery
```
EventSubscriptionQuery createEventSubscriptionQuery()
```
    Creates a new EventSubscriptionQuery instance, that can be used to query event subscriptions.
  - createVariableInstanceQuery
```
VariableInstanceQuery createVariableInstanceQuery()
```
    Creates a new VariableInstanceQuery instance, that can be used to query variable instances.
  - suspendProcessInstanceById
```
void suspendProcessInstanceById(String processInstanceId)
```
    Suspends the process instance with the given id. This means that the execution is stopped, so the token state will not change. However, actions that do not change token state, like setting/removing variables, etc. will succeed.
    
    Tasks belonging to this process instance will also be suspended. This means that any actions influencing the tasks' lifecycles will fail, such as
    - claiming
    - completing
    - delegation
    - changes in task assignees, owners, etc.
    Actions that only change task properties will succeed, such as changing variables or adding comments.
    
    If a process instance is in state suspended, the engine will also not execute jobs (timers, messages) associated with this instance.
    
    If you have a process instance hierarchy, suspending one process instance from the hierarchy will not suspend other process instances from that hierarchy.
    Throws:
    
    ProcessEngineException - if no such processInstance can be found.
  - activateProcessInstanceById
```
void activateProcessInstanceById(String processInstanceId)
```
    Activates the process instance with the given id.
    
    If you have a process instance hierarchy, activating one process instance from the hierarchy will not activate other process instances from that hierarchy.
    
    Throws:
    
    ProcessEngineException - if no such processInstance can be found.
  - signalEventReceived
```
void signalEventReceived(String signalName)
```
    Notifies the process engine that a signal event of name 'signalName' has been received. This method delivers the signal to all executions waiting on the signal.
    NOTE: The waiting executions are notified synchronously.
    
    Parameters:
    signalName - the name of the signal event
  - signalEventReceived
```
void signalEventReceived(String signalName,
                       Map<String,Object> processVariables)
```
    Notifies the process engine that a signal event of name 'signalName' has been received. This method delivers the signal to all executions waiting on the signal.
    NOTE: The waiting executions are notified synchronously.
    
    Parameters:
    signalName - the name of the signal event
    processVariables - a map of variables added to the execution(s)
  - signalEventReceived
```
void signalEventReceived(String signalName,
                       String executionId)
```
    Notifies the process engine that a signal event of name 'signalName' has been received. This method delivers the signal to a single execution, being the execution referenced by 'executionId'. The waiting execution is notified synchronously.
    
    Parameters:
    signalName - the name of the signal event
    executionId - the id of the execution to deliver the signal to
    
    Throws:
    
    ProcessEngineException - if no such execution exists or if the execution has not subscribed to the signal
  - signalEventReceived
```
void signalEventReceived(String signalName,
                       String executionId,
                       Map<String,Object> processVariables)
```
    Notifies the process engine that a signal event of name 'signalName' has been received. This method delivers the signal to a single execution, being the execution referenced by 'executionId'. The waiting execution is notified synchronously.
    
    Parameters:
    signalName - the name of the signal event
    executionId - the id of the execution to deliver the signal to
    processVariables - a map of variables added to the execution(s)
    
    Throws:
    
    ProcessEngineException - if no such execution exists or if the execution has not subscribed to the signal
  - messageEventReceived
```
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'. The waiting execution is notified synchronously.
    
    Parameters:
    messageName - the name of the message event
    executionId - the id of the execution to deliver the message to
    
    Throws:
    
    ProcessEngineException - if no such execution exists or if the execution has not subscribed to the signal
  - messageEventReceived
```
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'. The waiting execution is notified synchronously.
    
    Parameters:
    messageName - the name of the message event
    executionId - the id of the execution to deliver the message to
    processVariables - a map of variables added to the execution
    
    Throws:
    
    ProcessEngineException - if no such execution exists or if the execution has not subscribed to the signal
  - correlateMessage
```
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. Notification and instantiation happen synchronously.
    
    Parameters:
    messageName - the name of the message event
    
    Throws:
    
    MismatchingMessageCorrelationException - if none or more than one execution or process definition is correlated
    
    ProcessEngineException - if messageName is null
  - correlateMessage
```
void correlateMessage(String messageName,
                    String businessKey)
```
    Correlates a message to
    - an execution that is waiting for this message and belongs to a process instance with the given business key
    - a process definition that can be started by this message.
    Notification and instantiation happen synchronously.
    Parameters:
    messageName - the name of the message event
    businessKey - the business key of process instances to correlate against
    
    Throws:
    
    MismatchingMessageCorrelationException - if none or more than one execution or process definition is correlated
    
    ProcessEngineException - if messageName is null
  - correlateMessage
```
void correlateMessage(String messageName,
                    Map<String,Object> correlationKeys)
```
    Correlates a message to
    - an execution that is waiting for this message and can be correlated according to the given correlation keys. This is typically matched against process instance variables.
    - a process definition that can be started by this message.
    Notification and instantiation happen synchronously.
    Parameters:
    messageName - the name of the message event
    correlationKeys - a map of key value pairs that are used to correlate the message to an execution
    
    Throws:
    
    MismatchingMessageCorrelationException - if none or more than one execution or process definition is correlated
    
    ProcessEngineException - if messageName is null
  - correlateMessage
```
void correlateMessage(String messageName,
                    String businessKey,
                    Map<String,Object> processVariables)
```
    Correlates a message to
    - an execution that is waiting for this message and belongs to a process instance with the given business key
    - a process definition that can be started by this message.
    and updates the process instance variables. Notification and instantiation happen synchronously.
    Parameters:
    messageName - the name of the message event
    businessKey - the business key of process instances to correlate against
    
    Throws:
    
    MismatchingMessageCorrelationException - if none or more than one execution or process definition is correlated
    
    ProcessEngineException - if messageName is null
  - correlateMessage
```
void correlateMessage(String messageName,
                    Map<String,Object> correlationKeys,
                    Map<String,Object> processVariables)
```
    Correlates a message to
    - an execution that is waiting for this message and can be correlated according to the given correlation keys. This is typically matched against process instance variables.
    - a process definition that can be started by this message.
    and updates the process instance variables. Notification and instantiation happen synchronously.
    Parameters:
    messageName - the name of the message event
    correlationKeys - a map of key value pairs that are used to correlate the message to an execution
    processVariables - a map of variables added to the execution or newly created process instance
    
    Throws:
    
    MismatchingMessageCorrelationException - if none or more than one execution or process definition is correlated
    
    ProcessEngineException - if messageName is null
  - correlateMessage
```
void correlateMessage(String messageName,
                    String businessKey,
                    Map<String,Object> correlationKeys,
                    Map<String,Object> processVariables)
```
    Correlates a message to
    - an execution that is waiting for this message and can be correlated according to the given correlation keys. This is typically matched against process instance variables. The process instance it belongs to has to have the given business key.
    - a process definition that can be started by this message.
    and updates the process instance variables. Notification and instantiation happen synchronously.
    Parameters:
    messageName - the name of the message event
    businessKey - the business key of process instances to correlate against
    correlationKeys - a map of key value pairs that are used to correlate the message to an execution
    processVariables - a map of variables added to the execution or newly created process instance
    
    Throws:
    
    MismatchingMessageCorrelationException - if none or more than one execution or process definition is correlated
    
    ProcessEngineException - if messageName is null

Interface RuntimeService

Method Summary

Method Detail

startProcessInstanceByKey

startProcessInstanceByKey

startProcessInstanceByKey

startProcessInstanceByKey

startProcessInstanceById

startProcessInstanceById

startProcessInstanceById

startProcessInstanceById

startProcessInstanceByMessage

startProcessInstanceByMessage

startProcessInstanceByMessage

startProcessInstanceByMessage

deleteProcessInstance

getActiveActivityIds

getActivityInstance

Examples:

Identity & Uniqueness:

Relation to Executions

signal

signal

getVariables

getVariablesLocal

getVariables

getVariablesLocal

getVariable

getVariableLocal

setVariable

setVariableLocal

setVariables

setVariablesLocal

removeVariable

removeVariableLocal

removeVariables

removeVariablesLocal

createExecutionQuery

createNativeExecutionQuery

createProcessInstanceQuery

createNativeProcessInstanceQuery

createIncidentQuery

createEventSubscriptionQuery

createVariableInstanceQuery

suspendProcessInstanceById

activateProcessInstanceById

signalEventReceived

signalEventReceived

signalEventReceived

signalEventReceived

messageEventReceived

messageEventReceived

correlateMessage

correlateMessage

correlateMessage

correlateMessage

correlateMessage

correlateMessage