java.lang.Object
- org.activiti.engine.impl.ServiceImpl
- - org.activiti.engine.impl.RuntimeServiceImpl

All Implemented Interfaces:: RuntimeService

public class RuntimeServiceImpl
extends ServiceImpl
implements RuntimeService

Field Summary
- Fields inherited from class org.activiti.engine.impl.ServiceImpl
  commandExecutor, processEngineConfiguration

Constructor Summary

Constructors
Constructor Description

RuntimeServiceImpl()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`activateProcessInstanceById(String processInstanceId)`	Activates the process instance with the given id.
`void`	`addEventListener(ActivitiEventListener listenerToAdd)`	Adds an event-listener which will be notified of ALL events by the dispatcher.
`void`	`addEventListener(ActivitiEventListener listenerToAdd, ActivitiEventType... types)`	Adds an event-listener which will only be notified when an event occurs, which type is in the given types.
`void`	`addGroupIdentityLink(String processInstanceId, String groupId, String identityLinkType)`	Involves a group with a process instance.
`void`	`addParticipantGroup(String processInstanceId, String groupId)`	Convenience shorthand for `RuntimeService.addGroupIdentityLink(String, String, String)`; with type `IdentityLinkType.CANDIDATE`
`void`	`addParticipantUser(String processInstanceId, String userId)`	Convenience shorthand for `RuntimeService.addUserIdentityLink(String, String, String)`; with type `IdentityLinkType.CANDIDATE`
`void`	`addUserIdentityLink(String processInstanceId, String userId, String identityLinkType)`	Involves a user with a process instance.
`void`	`completeAdhocSubProcess(String executionId)`	Completes the ad-hoc sub process
`ExecutionQuery`	`createExecutionQuery()`	Creates a new `ExecutionQuery` instance, that can be used to query the executions and process instances.
`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
`ProcessInstance`	`createProcessInstance(ProcessInstanceBuilderImpl processInstanceBuilder)`
`ProcessInstanceBuilder`	`createProcessInstanceBuilder()`	Create a `ProcessInstanceBuilder`, that allows to set various options for starting a process instance, as an alternative to the various startProcessInstanceByXX methods.
`ProcessInstanceQuery`	`createProcessInstanceQuery()`	Creates a new `ProcessInstanceQuery` instance, that can be used to query process instances.
`void`	`deleteGroupIdentityLink(String processInstanceId, String groupId, String identityLinkType)`	Removes the association between a group and a process instance for the given identityLinkType.
`void`	`deleteParticipantGroup(String processInstanceId, String groupId)`	Convenience shorthand for `RuntimeService.deleteGroupIdentityLink(String, String, String)`; with type `IdentityLinkType.CANDIDATE`
`void`	`deleteParticipantUser(String processInstanceId, String userId)`	Convenience shorthand for `RuntimeService.deleteUserIdentityLink(String, String, String)`; with type `IdentityLinkType.CANDIDATE`
`void`	`deleteProcessInstance(String processInstanceId, String deleteReason)`	Delete an existing runtime process instance.
`void`	`deleteUserIdentityLink(String processInstanceId, String userId, String identityLinkType)`	Removes the association between a user and a process instance for the given identityLinkType.
`void`	`dispatchEvent(ActivitiEvent event)`	Dispatches the given event to any listeners that are registered.
`Execution`	`executeActivityInAdhocSubProcess(String executionId, String activityId)`	Executes an activity in a ad-hoc sub process
`List<String>`	`getActiveActivityIds(String executionId)`	Finds the activity ids for all executions that are waiting in activities.
`DataObject`	`getDataObject(String executionId, String dataObject)`	The DataObject.
`DataObject`	`getDataObject(String executionId, String dataObjectName, String locale, boolean withLocalizationFallback)`	The DataObject.
`DataObject`	`getDataObjectLocal(String executionId, String dataObjectName)`	The DataObject for an execution.
`DataObject`	`getDataObjectLocal(String executionId, String dataObjectName, String locale, boolean withLocalizationFallback)`	The DataObject for an execution.
`Map<String,DataObject>`	`getDataObjects(String executionId)`	All DataObjects visible from the given execution scope (including parent scopes).
`Map<String,DataObject>`	`getDataObjects(String executionId, String locale, boolean withLocalizationFallback)`	All DataObjects visible from the given execution scope (including parent scopes).
`Map<String,DataObject>`	`getDataObjects(String executionId, Collection<String> dataObjectNames)`	The DataObjects for all given dataObjectNames, takes all dataObjects into account which are visible from the given execution scope (including parent scopes).
`Map<String,DataObject>`	`getDataObjects(String executionId, Collection<String> dataObjectNames, String locale, boolean withLocalizationFallback)`	The DataObjects for all given dataObjectNames, takes all dataObjects into account which are visible from the given execution scope (including parent scopes).
`Map<String,DataObject>`	`getDataObjectsLocal(String executionId)`	All DataObject values that are defined in the execution scope, without taking outer scopes into account.
`Map<String,DataObject>`	`getDataObjectsLocal(String executionId, String locale, boolean withLocalizationFallback)`	All DataObject values that are defined in the execution scope, without taking outer scopes into account.
`Map<String,DataObject>`	`getDataObjectsLocal(String executionId, Collection<String> dataObjects)`	The DataObjects for the given dataObjectNames only taking the given execution scope into account, not looking in outer scopes.
`Map<String,DataObject>`	`getDataObjectsLocal(String executionId, Collection<String> dataObjectNames, String locale, boolean withLocalizationFallback)`	The DataObjects for the given dataObjectNames only taking the given execution scope into account, not looking in outer scopes.
`List<FlowNode>`	`getEnabledActivitiesFromAdhocSubProcess(String executionId)`	Gets enabled activities from ad-hoc sub process
`List<IdentityLink>`	`getIdentityLinksForProcessInstance(String processInstanceId)`	Retrieves the `IdentityLink`s associated with the given process instance.
`List<Event>`	`getProcessInstanceEvents(String processInstanceId)`	The all events related to the given Process Instance.
`Object`	`getVariable(String executionId, String variableName)`	The variable value.
`<T> T`	`getVariable(String executionId, String variableName, Class<T> variableClass)`	The variable value.
`VariableInstance`	`getVariableInstance(String executionId, String variableName)`	The variable.
`VariableInstance`	`getVariableInstanceLocal(String executionId, String variableName)`	The variable for an execution.
`Map<String,VariableInstance>`	`getVariableInstances(String executionId)`	All variables visible from the given execution scope (including parent scopes).
`Map<String,VariableInstance>`	`getVariableInstances(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).
`List<VariableInstance>`	`getVariableInstancesByExecutionIds(Set<String> executionIds)`	All variables visible from the given execution scope (including parent scopes).
`Map<String,VariableInstance>`	`getVariableInstancesLocal(String executionId)`	All variable values that are defined in the execution scope, without taking outer scopes into account.
`Map<String,VariableInstance>`	`getVariableInstancesLocal(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.
`Object`	`getVariableLocal(String executionId, String variableName)`	The variable value for an execution.
`<T> T`	`getVariableLocal(String executionId, String variableName, Class<T> variableClass)`	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.
`boolean`	`hasVariable(String executionId, String variableName)`	Check whether or not this execution has variable set with the given name, Searching for the variable is done in all scopes that are visible to the given execution (including parent scopes).
`boolean`	`hasVariableLocal(String executionId, String variableName)`	Check whether or not this execution has a local variable set with the given name.
`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`	`messageEventReceivedAsync(String messageName, String executionId)`	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`	`removeEventListener(ActivitiEventListener listenerToRemove)`	Removes the given listener from this dispatcher.
`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`	`setProcessInstanceName(String processInstanceId, String name)`	Sets the name for the process instance with the given id.
`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)`
`void`	`signal(String executionId, Map<String,Object> processVariables)`
`void`	`signalEventReceived(String signalName)`	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.
`void`	`signalEventReceived(String signalName, Map<String,Object> processVariables)`	Notifies the process engine that a signal event of name 'signalName' has been received.
`void`	`signalEventReceivedAsync(String signalName)`	Notifies the process engine that a signal event of name 'signalName' has been received.
`void`	`signalEventReceivedAsync(String signalName, String executionId)`	Notifies the process engine that a signal event of name 'signalName' has been received.
`void`	`signalEventReceivedAsyncWithTenantId(String signalName, String tenantId)`	Similar to `RuntimeService.signalEventReceivedAsync(String)`, but within the context of one tenant.
`void`	`signalEventReceivedWithTenantId(String signalName, String tenantId)`	Similar to `RuntimeService.signalEventReceived(String)`, but within the context of one tenant.
`void`	`signalEventReceivedWithTenantId(String signalName, Map<String,Object> processVariables, String tenantId)`	Similar to `#signalEventReceived(String, Map)`, but within the context of one tenant.
`ProcessInstance`	`startCreatedProcessInstance(ProcessInstance createdProcessInstance, Map<String,Object> variables)`	Starts a process instance previously created.
`ProcessInstance`	`startProcessInstance(ProcessInstanceBuilderImpl processInstanceBuilder)`
`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, 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, 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, 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, Map<String,Object> variables)`	Starts a new process instance in the latest version of the process definition with the given key
`ProcessInstance`	`startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String tenantId)`	Similar to `RuntimeService.startProcessInstanceByKey(String)`, but using a specific tenant identifier.
`ProcessInstance`	`startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, String tenantId)`	Similar to `RuntimeService.startProcessInstanceByKey(String, String)`, but using a specific tenant identifier.
`ProcessInstance`	`startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, Map<String,Object> variables, String tenantId)`	Similar to `RuntimeService.startProcessInstanceByKey(String, String, Map)`, but using a specific tenant identifier.
`ProcessInstance`	`startProcessInstanceByKeyAndTenantId(String processDefinitionKey, Map<String,Object> variables, String tenantId)`	Similar to `RuntimeService.startProcessInstanceByKey(String, Map)`, but using a specific tenant identifier.
`ProcessInstance`	`startProcessInstanceByMessage(String messageName)`	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`	`startProcessInstanceByMessage(String messageName, Map<String,Object> processVariables)`	Signals the process engine that a message is received and starts a new `ProcessInstance`.
`ProcessInstance`	`startProcessInstanceByMessageAndTenantId(String messageName, String tenantId)`	Similar to `RuntimeService.startProcessInstanceByMessage(String)`, but with tenant context.
`ProcessInstance`	`startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, String tenantId)`	Similar to `RuntimeService.startProcessInstanceByMessage(String, String)`, but with tenant context.
`ProcessInstance`	`startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, Map<String,Object> processVariables, String tenantId)`	Similar to `RuntimeService#startProcessInstanceByMessage(String, String, Map)`, but with tenant context.
`ProcessInstance`	`startProcessInstanceByMessageAndTenantId(String messageName, Map<String,Object> processVariables, String tenantId)`	Similar to `RuntimeService#startProcessInstanceByMessage(String, Map)`, but with tenant context.
`void`	`suspendProcessInstanceById(String processInstanceId)`	Suspends the process instance with the given id.
`void`	`trigger(String executionId)`	Sends an external trigger to an activity instance that is waiting inside the given execution.
`void`	`trigger(String executionId, Map<String,Object> processVariables)`	Sends an external trigger to an activity instance that is waiting inside the given execution.
`void`	`trigger(String executionId, Map<String,Object> processVariables, Map<String,Object> transientVariables)`	Similar to `RuntimeService.trigger(String, Map)`, but with an extra parameter that allows to pass transient variables.
`void`	`updateBusinessKey(String processInstanceId, String businessKey)`	Updates the business key for the provided process instance

Methods inherited from class org.activiti.engine.impl.ServiceImpl
getCommandExecutor, setCommandExecutor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RuntimeServiceImpl
```
public RuntimeServiceImpl()
```
- Method Detail
  - startProcessInstanceByKey
```
public ProcessInstance startProcessInstanceByKey(String processDefinitionKey)
```
    Description copied from interface: RuntimeService
    
    Starts a new process instance in the latest version of the process definition with the given key.
    
    Specified by:
    
    startProcessInstanceByKey in interface RuntimeService
    
    Parameters:
    
    processDefinitionKey - key of process definition, cannot be null.
  - startProcessInstanceByKey
```
public ProcessInstance startProcessInstanceByKey(String processDefinitionKey,
                                                 String businessKey)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    startProcessInstanceByKey in interface RuntimeService
    
    Parameters:
    
    processDefinitionKey - key of process definition, cannot be null.
    
    businessKey - a key that uniquely identifies the process instance in the context or the given process definition.
  - startProcessInstanceByKey
```
public ProcessInstance startProcessInstanceByKey(String processDefinitionKey,
                                                 Map<String,Object> variables)
```
    Description copied from interface: RuntimeService
    
    Starts a new process instance in the latest version of the process definition with the given key
    
    Specified by:
    
    startProcessInstanceByKey in interface RuntimeService
    
    Parameters:
    
    processDefinitionKey - key of process definition, cannot be null.
    
    variables - the variables to pass, can be null.
  - startProcessInstanceByKey
```
public ProcessInstance startProcessInstanceByKey(String processDefinitionKey,
                                                 String businessKey,
                                                 Map<String,Object> variables)
```
    Description copied from interface: RuntimeService
    
    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. The combination of processdefinitionKey-businessKey must be unique.
    
    Specified by:
    
    startProcessInstanceByKey in interface RuntimeService
    
    Parameters:
    
    processDefinitionKey - key of process definition, cannot be null.
    
    businessKey - a key that uniquely identifies the process instance in the context or the given process definition.
    
    variables - the variables to pass, can be null.
  - startProcessInstanceByKeyAndTenantId
```
public ProcessInstance startProcessInstanceByKeyAndTenantId(String processDefinitionKey,
                                                            String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService.startProcessInstanceByKey(String), but using a specific tenant identifier.
    
    Specified by:
    
    startProcessInstanceByKeyAndTenantId in interface RuntimeService
  - startProcessInstanceByKeyAndTenantId
```
public ProcessInstance startProcessInstanceByKeyAndTenantId(String processDefinitionKey,
                                                            String businessKey,
                                                            String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService.startProcessInstanceByKey(String, String), but using a specific tenant identifier.
    
    Specified by:
    
    startProcessInstanceByKeyAndTenantId in interface RuntimeService
  - startProcessInstanceByKeyAndTenantId
```
public ProcessInstance startProcessInstanceByKeyAndTenantId(String processDefinitionKey,
                                                            Map<String,Object> variables,
                                                            String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService.startProcessInstanceByKey(String, Map), but using a specific tenant identifier.
    
    Specified by:
    
    startProcessInstanceByKeyAndTenantId in interface RuntimeService
  - startProcessInstanceByKeyAndTenantId
```
public ProcessInstance startProcessInstanceByKeyAndTenantId(String processDefinitionKey,
                                                            String businessKey,
                                                            Map<String,Object> variables,
                                                            String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService.startProcessInstanceByKey(String, String, Map), but using a specific tenant identifier.
    
    Specified by:
    
    startProcessInstanceByKeyAndTenantId in interface RuntimeService
  - startProcessInstanceById
```
public ProcessInstance startProcessInstanceById(String processDefinitionId)
```
    Description copied from interface: RuntimeService
    
    Starts a new process instance in the exactly specified version of the process definition with the given id.
    
    Specified by:
    
    startProcessInstanceById in interface RuntimeService
    
    Parameters:
    
    processDefinitionId - the id of the process definition, cannot be null.
  - startProcessInstanceById
```
public ProcessInstance startProcessInstanceById(String processDefinitionId,
                                                String businessKey)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    startProcessInstanceById in interface RuntimeService
    
    Parameters:
    
    processDefinitionId - the id of the process definition, cannot be null.
    
    businessKey - a key that uniquely identifies the process instance in the context or the given process definition.
  - startProcessInstanceById
```
public ProcessInstance startProcessInstanceById(String processDefinitionId,
                                                Map<String,Object> variables)
```
    Description copied from interface: RuntimeService
    
    Starts a new process instance in the exactly specified version of the process definition with the given id.
    
    Specified by:
    
    startProcessInstanceById in interface RuntimeService
    
    Parameters:
    
    processDefinitionId - the id of the process definition, cannot be null.
    
    variables - variables to be passed, can be null
  - startProcessInstanceById
```
public ProcessInstance startProcessInstanceById(String processDefinitionId,
                                                String businessKey,
                                                Map<String,Object> variables)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    startProcessInstanceById in interface RuntimeService
    
    Parameters:
    
    processDefinitionId - the id of the process definition, cannot be null.
    
    variables - variables to be passed, can be null
  - deleteProcessInstance
```
public void deleteProcessInstance(String processInstanceId,
                                  String deleteReason)
```
    Description copied from interface: RuntimeService
    
    Delete an existing runtime process instance.
    
    Specified by:
    
    deleteProcessInstance in interface RuntimeService
    
    Parameters:
    
    processInstanceId - id of process instance to delete, cannot be null.
    
    deleteReason - reason for deleting, can be null.
  - createExecutionQuery
```
public ExecutionQuery createExecutionQuery()
```
    Description copied from interface: RuntimeService
    
    Creates a new ExecutionQuery instance, that can be used to query the executions and process instances.
    
    Specified by:
    
    createExecutionQuery in interface RuntimeService
  - createNativeExecutionQuery
```
public NativeExecutionQuery createNativeExecutionQuery()
```
    Description copied from interface: RuntimeService
    
    creates a new NativeExecutionQuery to query Executions by SQL directly
    
    Specified by:
    
    createNativeExecutionQuery in interface RuntimeService
  - createNativeProcessInstanceQuery
```
public NativeProcessInstanceQuery createNativeProcessInstanceQuery()
```
    Description copied from interface: RuntimeService
    
    creates a new NativeProcessInstanceQuery to query ProcessInstances by SQL directly
    
    Specified by:
    
    createNativeProcessInstanceQuery in interface RuntimeService
  - updateBusinessKey
```
public void updateBusinessKey(String processInstanceId,
                              String businessKey)
```
    Description copied from interface: RuntimeService
    
    Updates the business key for the provided process instance
    
    Specified by:
    
    updateBusinessKey in interface RuntimeService
    
    Parameters:
    
    processInstanceId - id of the process instance to set the business key, cannot be null
    
    businessKey - new businessKey value
  - getVariables
```
public Map<String,Object> getVariables(String executionId)
```
    Description copied from interface: RuntimeService
    
    All variables visible from the given execution scope (including parent scopes).
    
    Specified by:
    
    getVariables in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    Returns:
    
    the variables or an empty map if no such variables are found.
  - getVariableInstances
```
public Map<String,VariableInstance> getVariableInstances(String executionId)
```
    Description copied from interface: RuntimeService
    
    All variables visible from the given execution scope (including parent scopes).
    
    Specified by:
    
    getVariableInstances in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    Returns:
    
    the variable instances or an empty map if no such variables are found.
  - getVariableInstancesByExecutionIds
```
public List<VariableInstance> getVariableInstancesByExecutionIds(Set<String> executionIds)
```
    Description copied from interface: RuntimeService
    
    All variables visible from the given execution scope (including parent scopes).
    
    Specified by:
    
    getVariableInstancesByExecutionIds in interface RuntimeService
    
    Parameters:
    
    executionIds - ids of execution, cannot be null.
    
    Returns:
    
    the variables.
  - getVariablesLocal
```
public Map<String,Object> getVariablesLocal(String executionId)
```
    Description copied from interface: RuntimeService
    
    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 RuntimeService.getVariablesLocal(String, Collection) for better performance.
    
    Specified by:
    
    getVariablesLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    Returns:
    
    the variables or an empty map if no such variables are found.
  - getVariableInstancesLocal
```
public Map<String,VariableInstance> getVariableInstancesLocal(String executionId)
```
    Description copied from interface: RuntimeService
    
    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 RuntimeService.getVariableInstancesLocal(String, Collection) for better performance.
    
    Specified by:
    
    getVariableInstancesLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    Returns:
    
    the variables or an empty map if no such variables are found.
  - getVariables
```
public Map<String,Object> getVariables(String executionId,
                                             Collection<String> variableNames)
```
    Description copied from interface: RuntimeService
    
    The variable values for all given variableNames, takes all variables into account which are visible from the given execution scope (including parent scopes).
    
    Specified by:
    
    getVariables in interface RuntimeService
    
    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.
  - getVariableInstances
```
public Map<String,VariableInstance> getVariableInstances(String executionId,
                                                               Collection<String> variableNames)
```
    Description copied from interface: RuntimeService
    
    The variable values for all given variableNames, takes all variables into account which are visible from the given execution scope (including parent scopes).
    
    Specified by:
    
    getVariableInstances in interface RuntimeService
    
    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.
  - getVariablesLocal
```
public Map<String,Object> getVariablesLocal(String executionId,
                                                  Collection<String> variableNames)
```
    Description copied from interface: RuntimeService
    
    The variable values for the given variableNames only taking the given execution scope into account, not looking in outer scopes.
    
    Specified by:
    
    getVariablesLocal in interface RuntimeService
    
    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.
  - getVariableInstancesLocal
```
public Map<String,VariableInstance> getVariableInstancesLocal(String executionId,
                                                                    Collection<String> variableNames)
```
    Description copied from interface: RuntimeService
    
    The variable values for the given variableNames only taking the given execution scope into account, not looking in outer scopes.
    
    Specified by:
    
    getVariableInstancesLocal in interface RuntimeService
    
    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.
  - getVariable
```
public Object getVariable(String executionId,
                          String variableName)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    getVariable in interface RuntimeService
    
    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.
  - getVariableInstance
```
public VariableInstance getVariableInstance(String executionId,
                                            String variableName)
```
    Description copied from interface: RuntimeService
    
    The variable. 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.
    
    Specified by:
    
    getVariableInstance in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    variableName - name of variable, cannot be null.
    
    Returns:
    
    the variable or null if the variable is undefined.
  - getVariable
```
public <T> T getVariable(String executionId,
                         String variableName,
                         Class<T> variableClass)
```
    Description copied from interface: RuntimeService
    
    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. Throws ClassCastException when cannot cast variable to given class
    
    Specified by:
    
    getVariable in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    variableName - name of variable, cannot be null.
    
    variableClass - 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.
  - hasVariable
```
public boolean hasVariable(String executionId,
                           String variableName)
```
    Description copied from interface: RuntimeService
    
    Check whether or not this execution has variable set with the given name, Searching for the variable is done in all scopes that are visible to the given execution (including parent scopes).
    
    Specified by:
    
    hasVariable in interface RuntimeService
  - getVariableLocal
```
public Object getVariableLocal(String executionId,
                               String variableName)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    getVariableLocal in interface RuntimeService
  - getVariableInstanceLocal
```
public VariableInstance getVariableInstanceLocal(String executionId,
                                                 String variableName)
```
    Description copied from interface: RuntimeService
    
    The variable for an execution. Returns the variable when it is set for the execution (and not searching parent scopes). Returns null when no variable is found with the given name or when the value is set to null.
    
    Specified by:
    
    getVariableInstanceLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    variableName - name of variable, cannot be null.
    
    Returns:
    
    the variable or null if the variable is undefined.
  - getVariableLocal
```
public <T> T getVariableLocal(String executionId,
                              String variableName,
                              Class<T> variableClass)
```
    Description copied from interface: RuntimeService
    
    The variable value for an execution. Returns the value casted to given class 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.
    
    Specified by:
    
    getVariableLocal in interface RuntimeService
  - hasVariableLocal
```
public boolean hasVariableLocal(String executionId,
                                String variableName)
```
    Description copied from interface: RuntimeService
    
    Check whether or not this execution has a local variable set with the given name.
    
    Specified by:
    
    hasVariableLocal in interface RuntimeService
  - setVariable
```
public void setVariable(String executionId,
                        String variableName,
                        Object value)
```
    Description copied from interface: RuntimeService
    
    Update or create a variable for an execution.
    The variable is set according to the algorithm as documented for VariableScope.setVariable(String, Object).
    
    Specified by:
    
    setVariable in interface RuntimeService
    
    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.
    
    See Also:
    
    VariableScope.setVariable(String, Object)
  - setVariableLocal
```
public void setVariableLocal(String executionId,
                             String variableName,
                             Object value)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    setVariableLocal in interface RuntimeService
    
    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.
  - setVariables
```
public void setVariables(String executionId,
                         Map<String,? extends Object> variables)
```
    Description copied from interface: RuntimeService
    
    Update or create given variables for an execution (including parent scopes).
    Variables are set according to the algorithm as documented for VariableScope.setVariables(Map), applied separately to each variable.
    
    Specified by:
    
    setVariables in interface RuntimeService
    
    Parameters:
    
    executionId - id of the execution, cannot be null.
    
    variables - map containing name (key) and value of variables, can be null.
    
    See Also:
    
    VariableScope.setVariables(Map)
  - setVariablesLocal
```
public void setVariablesLocal(String executionId,
                              Map<String,? extends Object> variables)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    setVariablesLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of the execution, cannot be null.
    
    variables - map containing name (key) and value of variables, can be null.
  - removeVariable
```
public void removeVariable(String executionId,
                           String variableName)
```
    Description copied from interface: RuntimeService
    
    Removes a variable for an execution.
    
    Specified by:
    
    removeVariable in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution to remove variable in.
    
    variableName - name of variable to remove.
  - removeVariableLocal
```
public void removeVariableLocal(String executionId,
                                String variableName)
```
    Description copied from interface: RuntimeService
    
    Removes a variable for an execution (not considering parent scopes).
    
    Specified by:
    
    removeVariableLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution to remove variable in.
    
    variableName - name of variable to remove.
  - removeVariables
```
public void removeVariables(String executionId,
                            Collection<String> variableNames)
```
    Description copied from interface: RuntimeService
    
    Removes variables for an execution.
    
    Specified by:
    
    removeVariables in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution to remove variable in.
    
    variableNames - collection containing name of variables to remove.
  - removeVariablesLocal
```
public void removeVariablesLocal(String executionId,
                                 Collection<String> variableNames)
```
    Description copied from interface: RuntimeService
    
    Remove variables for an execution (not considering parent scopes).
    
    Specified by:
    
    removeVariablesLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution to remove variable in.
    
    variableNames - collection containing name of variables to remove.
  - getDataObjects
```
public Map<String,DataObject> getDataObjects(String executionId)
```
    Description copied from interface: RuntimeService
    
    All DataObjects visible from the given execution scope (including parent scopes).
    
    Specified by:
    
    getDataObjects in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    Returns:
    
    the DataObjects or an empty map if no such variables are found.
  - getDataObjects
```
public Map<String,DataObject> getDataObjects(String executionId,
                                                   String locale,
                                                   boolean withLocalizationFallback)
```
    Description copied from interface: RuntimeService
    
    All DataObjects visible from the given execution scope (including parent scopes).
    
    Specified by:
    
    getDataObjects in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    locale - locale the DataObject name and description should be returned in (if available).
    
    withLocalizationFallback - When true localization will fallback to more general locales if the specified locale is not found.
    
    Returns:
    
    the DataObjects or an empty map if no DataObjects are found.
  - getDataObjectsLocal
```
public Map<String,DataObject> getDataObjectsLocal(String executionId)
```
    Description copied from interface: RuntimeService
    
    All DataObject values that are defined in the execution scope, without taking outer scopes into account. If you have many local DataObjects and you only need a few, consider using RuntimeService.getDataObjectsLocal(String, Collection) for better performance.
    
    Specified by:
    
    getDataObjectsLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    Returns:
    
    the DataObjects or an empty map if no DataObjects are found.
  - getDataObjectsLocal
```
public Map<String,DataObject> getDataObjectsLocal(String executionId,
                                                        String locale,
                                                        boolean withLocalizationFallback)
```
    Description copied from interface: RuntimeService
    
    All DataObject values that are defined in the execution scope, without taking outer scopes into account. If you have many local DataObjects and you only need a few, consider using RuntimeService.getDataObjectsLocal(String, Collection) for better performance.
    
    Specified by:
    
    getDataObjectsLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    locale - locale the DataObject name and description should be returned in (if available).
    
    withLocalizationFallback - When true localization will fallback to more general locales if the specified locale is not found.
    
    Returns:
    
    the DataObjects or an empty map if no such variables are found.
  - getDataObjects
```
public Map<String,DataObject> getDataObjects(String executionId,
                                                   Collection<String> dataObjectNames)
```
    Description copied from interface: RuntimeService
    
    The DataObjects for all given dataObjectNames, takes all dataObjects into account which are visible from the given execution scope (including parent scopes).
    
    Specified by:
    
    getDataObjects in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    dataObjectNames - the collection of DataObject names that should be retrieved.
    
    Returns:
    
    the DataObject or an empty map if no DataObjects are found.
  - getDataObjects
```
public Map<String,DataObject> getDataObjects(String executionId,
                                                   Collection<String> dataObjectNames,
                                                   String locale,
                                                   boolean withLocalizationFallback)
```
    Description copied from interface: RuntimeService
    
    The DataObjects for all given dataObjectNames, takes all dataObjects into account which are visible from the given execution scope (including parent scopes).
    
    Specified by:
    
    getDataObjects in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    dataObjectNames - the collection of DataObject names that should be retrieved.
    
    locale - locale the DataObject name and description should be returned in (if available).
    
    withLocalizationFallback - When true localization will fallback to more general locales if the specified locale is not found.
    
    Returns:
    
    the DataObjects or an empty map if no such dataObjects are found.
  - getDataObjectsLocal
```
public Map<String,DataObject> getDataObjectsLocal(String executionId,
                                                        Collection<String> dataObjects)
```
    Description copied from interface: RuntimeService
    
    The DataObjects for the given dataObjectNames only taking the given execution scope into account, not looking in outer scopes.
    
    Specified by:
    
    getDataObjectsLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    Returns:
    
    the DataObjects or an empty map if no DataObjects are found.
  - getDataObjectsLocal
```
public Map<String,DataObject> getDataObjectsLocal(String executionId,
                                                        Collection<String> dataObjectNames,
                                                        String locale,
                                                        boolean withLocalizationFallback)
```
    Description copied from interface: RuntimeService
    
    The DataObjects for the given dataObjectNames only taking the given execution scope into account, not looking in outer scopes.
    
    Specified by:
    
    getDataObjectsLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    dataObjectNames - the collection of DataObject names that should be retrieved.
    
    locale - locale the DataObject name and description should be returned in (if available).
    
    withLocalizationFallback - When true localization will fallback to more general locales if the specified locale is not found.
    
    Returns:
    
    the DataObjects or an empty map if no DataObjects are found.
  - getDataObject
```
public DataObject getDataObject(String executionId,
                                String dataObject)
```
    Description copied from interface: RuntimeService
    
    The DataObject. Searching for the DataObject is done in all scopes that are visible to the given execution (including parent scopes). Returns null when no DataObject value is found with the given name or when the value is set to null.
    
    Specified by:
    
    getDataObject in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    Returns:
    
    the DataObject or null if the variable is undefined.
  - getDataObject
```
public DataObject getDataObject(String executionId,
                                String dataObjectName,
                                String locale,
                                boolean withLocalizationFallback)
```
    Description copied from interface: RuntimeService
    
    The DataObject. Searching for the DataObject is done in all scopes that are visible to the given execution (including parent scopes). Returns null when no DataObject value is found with the given name or when the value is set to null.
    
    Specified by:
    
    getDataObject in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    dataObjectName - name of DataObject, cannot be null.
    
    locale - locale the DataObject name and description should be returned in (if available).
    
    withLocalizationFallback - When true localization will fallback to more general locales including the default locale of the JVM if the specified locale is not found.
    
    Returns:
    
    the DataObject or null if the DataObject is undefined.
  - getDataObjectLocal
```
public DataObject getDataObjectLocal(String executionId,
                                     String dataObjectName)
```
    Description copied from interface: RuntimeService
    
    The DataObject for an execution. Returns the DataObject when it is set for the execution (and not searching parent scopes). Returns null when no DataObject is found with the given name.
    
    Specified by:
    
    getDataObjectLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    dataObjectName - name of DataObject, cannot be null.
    
    Returns:
    
    the DataObject or null if the DataObject is undefined.
  - getDataObjectLocal
```
public DataObject getDataObjectLocal(String executionId,
                                     String dataObjectName,
                                     String locale,
                                     boolean withLocalizationFallback)
```
    Description copied from interface: RuntimeService
    
    The DataObject for an execution. Returns the DataObject when it is set for the execution (and not searching parent scopes). Returns null when no DataObject is found with the given name.
    
    Specified by:
    
    getDataObjectLocal in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution, cannot be null.
    
    dataObjectName - name of DataObject, cannot be null.
    
    locale - locale the DataObject name and description should be returned in (if available).
    
    withLocalizationFallback - When true localization will fallback to more general locales if the specified locale is not found.
    
    Returns:
    
    the DataObject or null if the DataObject is undefined.
  - signal
```
public void signal(String executionId)
```
  - trigger
```
public void trigger(String executionId)
```
    Description copied from interface: RuntimeService
    
    Sends an external trigger to an activity instance that is waiting inside the given execution.
    
    Specified by:
    
    trigger in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution to signal, cannot be null.
  - signal
```
public void signal(String executionId,
                   Map<String,Object> processVariables)
```
  - trigger
```
public void trigger(String executionId,
                    Map<String,Object> processVariables)
```
    Description copied from interface: RuntimeService
    
    Sends an external trigger to an activity instance that is waiting inside the given execution.
    
    Specified by:
    
    trigger in interface RuntimeService
    
    Parameters:
    
    executionId - id of execution to signal, cannot be null.
    
    processVariables - a map of process variables
  - trigger
```
public void trigger(String executionId,
                    Map<String,Object> processVariables,
                    Map<String,Object> transientVariables)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService.trigger(String, Map), but with an extra parameter that allows to pass transient variables.
    
    Specified by:
    
    trigger in interface RuntimeService
  - addUserIdentityLink
```
public void addUserIdentityLink(String processInstanceId,
                                String userId,
                                String identityLinkType)
```
    Description copied from interface: RuntimeService
    
    Involves a user with a process instance. The type of identity link is defined by the given identityLinkType.
    
    Specified by:
    
    addUserIdentityLink in interface RuntimeService
    
    Parameters:
    
    processInstanceId - id of the process instance, cannot be null.
    
    userId - id of the user involve, cannot be null.
    
    identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).
  - addGroupIdentityLink
```
public void addGroupIdentityLink(String processInstanceId,
                                 String groupId,
                                 String identityLinkType)
```
    Description copied from interface: RuntimeService
    
    Involves a group with a process instance. The type of identityLink is defined by the given identityLink.
    
    Specified by:
    
    addGroupIdentityLink in interface RuntimeService
    
    Parameters:
    
    processInstanceId - id of the process instance, cannot be null.
    
    groupId - id of the group to involve, cannot be null.
    
    identityLinkType - type of identity, cannot be null (@see IdentityLinkType).
  - addParticipantUser
```
public void addParticipantUser(String processInstanceId,
                               String userId)
```
    Description copied from interface: RuntimeService
    
    Convenience shorthand for RuntimeService.addUserIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE
    
    Specified by:
    
    addParticipantUser in interface RuntimeService
    
    Parameters:
    
    processInstanceId - id of the process instance, cannot be null.
    
    userId - id of the user to use as candidate, cannot be null.
  - addParticipantGroup
```
public void addParticipantGroup(String processInstanceId,
                                String groupId)
```
    Description copied from interface: RuntimeService
    
    Convenience shorthand for RuntimeService.addGroupIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE
    
    Specified by:
    
    addParticipantGroup in interface RuntimeService
    
    Parameters:
    
    processInstanceId - id of the process instance, cannot be null.
    
    groupId - id of the group to use as candidate, cannot be null.
  - deleteParticipantUser
```
public void deleteParticipantUser(String processInstanceId,
                                  String userId)
```
    Description copied from interface: RuntimeService
    
    Convenience shorthand for RuntimeService.deleteUserIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE
    
    Specified by:
    
    deleteParticipantUser in interface RuntimeService
    
    Parameters:
    
    processInstanceId - id of the process instance, cannot be null.
    
    userId - id of the user to use as candidate, cannot be null.
  - deleteParticipantGroup
```
public void deleteParticipantGroup(String processInstanceId,
                                   String groupId)
```
    Description copied from interface: RuntimeService
    
    Convenience shorthand for RuntimeService.deleteGroupIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE
    
    Specified by:
    
    deleteParticipantGroup in interface RuntimeService
    
    Parameters:
    
    processInstanceId - id of the process instance, cannot be null.
    
    groupId - id of the group to use as candidate, cannot be null.
  - deleteUserIdentityLink
```
public void deleteUserIdentityLink(String processInstanceId,
                                   String userId,
                                   String identityLinkType)
```
    Description copied from interface: RuntimeService
    
    Removes the association between a user and a process instance for the given identityLinkType.
    
    Specified by:
    
    deleteUserIdentityLink in interface RuntimeService
    
    Parameters:
    
    processInstanceId - id of the process instance, cannot be null.
    
    userId - id of the user involve, cannot be null.
    
    identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).
  - deleteGroupIdentityLink
```
public void deleteGroupIdentityLink(String processInstanceId,
                                    String groupId,
                                    String identityLinkType)
```
    Description copied from interface: RuntimeService
    
    Removes the association between a group and a process instance for the given identityLinkType.
    
    Specified by:
    
    deleteGroupIdentityLink in interface RuntimeService
    
    Parameters:
    
    processInstanceId - id of the process instance, cannot be null.
    
    groupId - id of the group to involve, cannot be null.
    
    identityLinkType - type of identity, cannot be null (@see IdentityLinkType).
  - getIdentityLinksForProcessInstance
```
public List<IdentityLink> getIdentityLinksForProcessInstance(String processInstanceId)
```
    Description copied from interface: RuntimeService
    
    Retrieves the IdentityLinks associated with the given process instance. Such an IdentityLink informs how a certain user is involved with a process instance.
    
    Specified by:
    
    getIdentityLinksForProcessInstance in interface RuntimeService
  - createProcessInstanceQuery
```
public ProcessInstanceQuery createProcessInstanceQuery()
```
    Description copied from interface: RuntimeService
    
    Creates a new ProcessInstanceQuery instance, that can be used to query process instances.
    
    Specified by:
    
    createProcessInstanceQuery in interface RuntimeService
  - getActiveActivityIds
```
public List<String> getActiveActivityIds(String executionId)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    getActiveActivityIds in interface RuntimeService
    
    Parameters:
    
    executionId - id of the execution, cannot be null.
  - suspendProcessInstanceById
```
public void suspendProcessInstanceById(String processInstanceId)
```
    Description copied from interface: RuntimeService
    
    Suspends the process instance with the given id. If a process instance is in state suspended, activiti will not execute jobs (timers, messages) associated with this instance. If you have a process instance hierarchy, suspending one process instance form the hierarchy will not suspend other process instances form that hierarchy.
    
    Specified by:
    
    suspendProcessInstanceById in interface RuntimeService
  - activateProcessInstanceById
```
public void activateProcessInstanceById(String processInstanceId)
```
    Description copied from interface: RuntimeService
    
    Activates the process instance with the given id. If you have a process instance hierarchy, suspending one process instance form the hierarchy will not suspend other process instances form that hierarchy.
    
    Specified by:
    
    activateProcessInstanceById in interface RuntimeService
  - startProcessInstanceByMessage
```
public ProcessInstance startProcessInstanceByMessage(String messageName)
```
    Description copied from interface: RuntimeService
    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, ActivitiException is thrown
    Specified by:
    
    startProcessInstanceByMessage in interface RuntimeService
    
    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
  - startProcessInstanceByMessageAndTenantId
```
public ProcessInstance startProcessInstanceByMessageAndTenantId(String messageName,
                                                                String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService.startProcessInstanceByMessage(String), but with tenant context.
    
    Specified by:
    
    startProcessInstanceByMessageAndTenantId in interface RuntimeService
  - startProcessInstanceByMessage
```
public ProcessInstance startProcessInstanceByMessage(String messageName,
                                                     String businessKey)
```
    Description copied from interface: RuntimeService
    
    Signals the process engine that a message is received and starts a new ProcessInstance.
    See RuntimeService.startProcessInstanceByMessage(String, Map). This method allows specifying a business key.
    
    Specified by:
    
    startProcessInstanceByMessage in interface RuntimeService
    
    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
  - startProcessInstanceByMessageAndTenantId
```
public ProcessInstance startProcessInstanceByMessageAndTenantId(String messageName,
                                                                String businessKey,
                                                                String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService.startProcessInstanceByMessage(String, String), but with tenant context.
    
    Specified by:
    
    startProcessInstanceByMessageAndTenantId in interface RuntimeService
  - startProcessInstanceByMessage
```
public ProcessInstance startProcessInstanceByMessage(String messageName,
                                                     Map<String,Object> processVariables)
```
    Description copied from interface: RuntimeService
    
    Signals the process engine that a message is received and starts a new ProcessInstance.
    See RuntimeService.startProcessInstanceByMessage(String). In addition, this method allows specifying a the payload of the message as a map of process variables.
    
    Specified by:
    
    startProcessInstanceByMessage in interface RuntimeService
    
    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
  - startProcessInstanceByMessageAndTenantId
```
public ProcessInstance startProcessInstanceByMessageAndTenantId(String messageName,
                                                                Map<String,Object> processVariables,
                                                                String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService#startProcessInstanceByMessage(String, Map), but with tenant context.
    
    Specified by:
    
    startProcessInstanceByMessageAndTenantId in interface RuntimeService
  - startProcessInstanceByMessage
```
public ProcessInstance startProcessInstanceByMessage(String messageName,
                                                     String businessKey,
                                                     Map<String,Object> processVariables)
```
    Description copied from interface: RuntimeService
    
    Signals the process engine that a message is received and starts a new ProcessInstance.
    See RuntimeService.startProcessInstanceByMessage(String, Map). In addition, this method allows specifying a business key.
    
    Specified by:
    
    startProcessInstanceByMessage in interface RuntimeService
    
    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
  - startProcessInstanceByMessageAndTenantId
```
public ProcessInstance startProcessInstanceByMessageAndTenantId(String messageName,
                                                                String businessKey,
                                                                Map<String,Object> processVariables,
                                                                String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService#startProcessInstanceByMessage(String, String, Map), but with tenant context.
    
    Specified by:
    
    startProcessInstanceByMessageAndTenantId in interface RuntimeService
  - signalEventReceived
```
public void signalEventReceived(String signalName)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    signalEventReceived in interface RuntimeService
    
    Parameters:
    
    signalName - the name of the signal event
  - signalEventReceivedWithTenantId
```
public void signalEventReceivedWithTenantId(String signalName,
                                            String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService.signalEventReceived(String), but within the context of one tenant.
    
    Specified by:
    
    signalEventReceivedWithTenantId in interface RuntimeService
  - signalEventReceivedAsync
```
public void signalEventReceivedAsync(String signalName)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    signalEventReceivedAsync in interface RuntimeService
    
    Parameters:
    
    signalName - the name of the signal event
  - signalEventReceivedAsyncWithTenantId
```
public void signalEventReceivedAsyncWithTenantId(String signalName,
                                                 String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to RuntimeService.signalEventReceivedAsync(String), but within the context of one tenant.
    
    Specified by:
    
    signalEventReceivedAsyncWithTenantId in interface RuntimeService
  - signalEventReceived
```
public void signalEventReceived(String signalName,
                                Map<String,Object> processVariables)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    signalEventReceived in interface RuntimeService
    
    Parameters:
    
    signalName - the name of the signal event
    
    processVariables - a map of variables added to the execution(s)
  - signalEventReceivedWithTenantId
```
public void signalEventReceivedWithTenantId(String signalName,
                                            Map<String,Object> processVariables,
                                            String tenantId)
```
    Description copied from interface: RuntimeService
    
    Similar to #signalEventReceived(String, Map), but within the context of one tenant.
    
    Specified by:
    
    signalEventReceivedWithTenantId in interface RuntimeService
  - signalEventReceived
```
public void signalEventReceived(String signalName,
                                String executionId)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    signalEventReceived in interface RuntimeService
    
    Parameters:
    
    signalName - the name of the signal event
    
    executionId - the id of the execution to deliver the signal to
  - signalEventReceived
```
public void signalEventReceived(String signalName,
                                String executionId,
                                Map<String,Object> processVariables)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    signalEventReceived in interface RuntimeService
    
    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)
  - signalEventReceivedAsync
```
public void signalEventReceivedAsync(String signalName,
                                     String executionId)
```
    Description copied from interface: RuntimeService
    
    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 asynchronously.
    
    Specified by:
    
    signalEventReceivedAsync in interface RuntimeService
    
    Parameters:
    
    signalName - the name of the signal event
    
    executionId - the id of the execution to deliver the signal to
  - messageEventReceived
```
public void messageEventReceived(String messageName,
                                 String executionId)
```
    Description copied from interface: RuntimeService
    
    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.
    
    Specified by:
    
    messageEventReceived in interface RuntimeService
    
    Parameters:
    
    messageName - the name of the message event
    
    executionId - the id of the execution to deliver the message to
  - messageEventReceived
```
public void messageEventReceived(String messageName,
                                 String executionId,
                                 Map<String,Object> processVariables)
```
    Description copied from interface: RuntimeService
    
    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.
    Variables are set for the scope of the execution of the message event subscribed to the message name. For example:
  - The scope for an intermediate message event in the main process is that of the process instance
  - The scope for an intermediate message event in a subprocess is that of the subprocess
  - The scope for a boundary message event is that of the execution for the Activity the event is attached to

Specified by:: messageEventReceived in interface RuntimeService
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
See Also:: VariableScope.setVariables(Map)

messageEventReceivedAsync
```
public void messageEventReceivedAsync(String messageName,
                                      String executionId)
```
Description copied from interface: RuntimeService

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 asynchronously.

Specified by:

messageEventReceivedAsync in interface RuntimeService

Parameters:

messageName - the name of the message event

executionId - the id of the execution to deliver the message to

addEventListener
```
public void addEventListener(ActivitiEventListener listenerToAdd)
```
Description copied from interface: RuntimeService

Adds an event-listener which will be notified of ALL events by the dispatcher.

Specified by:

addEventListener in interface RuntimeService

Parameters:

listenerToAdd - the listener to add

addEventListener
```
public void addEventListener(ActivitiEventListener listenerToAdd,
                             ActivitiEventType... types)
```
Description copied from interface: RuntimeService

Adds an event-listener which will only be notified when an event occurs, which type is in the given types.

Specified by:

addEventListener in interface RuntimeService

Parameters:

listenerToAdd - the listener to add

types - types of events the listener should be notified for

removeEventListener
```
public void removeEventListener(ActivitiEventListener listenerToRemove)
```
Description copied from interface: RuntimeService

Removes the given listener from this dispatcher. The listener will no longer be notified, regardless of the type(s) it was registered for in the first place.

Specified by:

removeEventListener in interface RuntimeService

Parameters:

listenerToRemove - listener to remove

dispatchEvent
```
public void dispatchEvent(ActivitiEvent event)
```
Description copied from interface: RuntimeService

Dispatches the given event to any listeners that are registered.

Specified by:

dispatchEvent in interface RuntimeService

Parameters:

event - event to dispatch.

setProcessInstanceName
```
public void setProcessInstanceName(String processInstanceId,
                                   String name)
```
Description copied from interface: RuntimeService

Sets the name for the process instance with the given id.

Specified by:

setProcessInstanceName in interface RuntimeService

Parameters:

processInstanceId - id of the process instance to update

name - new name for the process instance

getProcessInstanceEvents
```
public List<Event> getProcessInstanceEvents(String processInstanceId)
```
Description copied from interface: RuntimeService

The all events related to the given Process Instance.

Specified by:

getProcessInstanceEvents in interface RuntimeService

getEnabledActivitiesFromAdhocSubProcess
```
public List<FlowNode> getEnabledActivitiesFromAdhocSubProcess(String executionId)
```
Description copied from interface: RuntimeService

Gets enabled activities from ad-hoc sub process

Specified by:

getEnabledActivitiesFromAdhocSubProcess in interface RuntimeService

Parameters:

executionId - id of the execution that has an ad-hoc sub process as current flow element

Returns:

a list of enabled activities

executeActivityInAdhocSubProcess
```
public Execution executeActivityInAdhocSubProcess(String executionId,
                                                  String activityId)
```
Description copied from interface: RuntimeService

Executes an activity in a ad-hoc sub process

Specified by:

executeActivityInAdhocSubProcess in interface RuntimeService

Parameters:

executionId - id of the execution that has an ad-hoc sub process as current flow element

activityId - id of the activity id to enable

Returns:

the newly created execution of the enabled activity

completeAdhocSubProcess
```
public void completeAdhocSubProcess(String executionId)
```
Description copied from interface: RuntimeService

Completes the ad-hoc sub process

Specified by:

completeAdhocSubProcess in interface RuntimeService

Parameters:

executionId - id of the execution that has an ad-hoc sub process as current flow element

createProcessInstanceBuilder
```
public ProcessInstanceBuilder createProcessInstanceBuilder()
```
Description copied from interface: RuntimeService

Create a ProcessInstanceBuilder, that allows to set various options for starting a process instance, as an alternative to the various startProcessInstanceByXX methods.

Specified by:

createProcessInstanceBuilder in interface RuntimeService

startCreatedProcessInstance
```
public ProcessInstance startCreatedProcessInstance(ProcessInstance createdProcessInstance,
                                                   Map<String,Object> variables)
```
Description copied from interface: RuntimeService

Starts a process instance previously created.

Specified by:

startCreatedProcessInstance in interface RuntimeService

Parameters:

createdProcessInstance - The already created process instance.

startProcessInstance

public ProcessInstance startProcessInstance(ProcessInstanceBuilderImpl processInstanceBuilder)

createProcessInstance

public ProcessInstance createProcessInstance(ProcessInstanceBuilderImpl processInstanceBuilder)

Class RuntimeServiceImpl

Field Summary

Fields inherited from class org.activiti.engine.impl.ServiceImpl

Constructor Summary

Method Summary

Methods inherited from class org.activiti.engine.impl.ServiceImpl

Methods inherited from class java.lang.Object

Constructor Detail

RuntimeServiceImpl

Method Detail

startProcessInstanceByKey

startProcessInstanceByKey

startProcessInstanceByKey

startProcessInstanceByKey

startProcessInstanceByKeyAndTenantId

startProcessInstanceByKeyAndTenantId

startProcessInstanceByKeyAndTenantId

startProcessInstanceByKeyAndTenantId

startProcessInstanceById

startProcessInstanceById

startProcessInstanceById

startProcessInstanceById

deleteProcessInstance

createExecutionQuery

createNativeExecutionQuery

createNativeProcessInstanceQuery

updateBusinessKey

getVariables

getVariableInstances

getVariableInstancesByExecutionIds

getVariablesLocal

getVariableInstancesLocal

getVariables

getVariableInstances

getVariablesLocal

getVariableInstancesLocal

getVariable

getVariableInstance

getVariable

hasVariable

getVariableLocal

getVariableInstanceLocal

getVariableLocal

hasVariableLocal

setVariable

setVariableLocal

setVariables

setVariablesLocal

removeVariable

removeVariableLocal

removeVariables

removeVariablesLocal

getDataObjects

getDataObjects

getDataObjectsLocal

getDataObjectsLocal

getDataObjects

getDataObjects

getDataObjectsLocal

getDataObjectsLocal

getDataObject

getDataObject

getDataObjectLocal

getDataObjectLocal

signal

trigger

signal

trigger

trigger

addUserIdentityLink

addGroupIdentityLink

addParticipantUser

addParticipantGroup

deleteParticipantUser

deleteParticipantGroup

deleteUserIdentityLink

deleteGroupIdentityLink

getIdentityLinksForProcessInstance

createProcessInstanceQuery

getActiveActivityIds