Package org.flowable.engine

Interface RuntimeService

All Known Implementing Classes:
RuntimeServiceImpl
public interface RuntimeService
Author:
Tom Baeyens, Joram Barrez, Daniel Meyer

  • Method Details

    • createProcessInstanceBuilder

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

    • 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:
      FlowableObjectNotFoundException - 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.

      Parameters:
      processDefinitionKey - key of process definition, cannot be null.
      businessKey - a key that identifies the process instance and can be used to retrieve the process instance later via the query API.
      Throws:
      FlowableObjectNotFoundException - 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:
      FlowableObjectNotFoundException - 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.

      Parameters:
      processDefinitionKey - key of process definition, cannot be null.
      variables - the variables to pass, can be null.
      businessKey - a key that identifies the process instance and can be used to retrieve the process instance later via the query API.
      Throws:
      FlowableObjectNotFoundException - when no process definition is deployed with the given key.

    • startProcessInstanceByKeyAndTenantId

      ProcessInstance startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String tenantId)
      Similar to startProcessInstanceByKey(String), but using a specific tenant identifier.

    • startProcessInstanceByKeyAndTenantId

      ProcessInstance startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, String tenantId)
      Similar to startProcessInstanceByKey(String, String), but using a specific tenant identifier.

    • startProcessInstanceByKeyAndTenantId

      ProcessInstance startProcessInstanceByKeyAndTenantId(String processDefinitionKey, Map<String,Object> variables, String tenantId)
      Similar to startProcessInstanceByKey(String, Map), but using a specific tenant identifier.

    • startProcessInstanceByKeyAndTenantId

      ProcessInstance startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, Map<String,Object> variables, String tenantId)
      Similar to startProcessInstanceByKey(String, String, Map), but using a specific tenant identifier.

    • 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:
      FlowableObjectNotFoundException - 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.

      Parameters:
      processDefinitionId - the id of the process definition, cannot be null.
      businessKey - a key that identifies the process instance and can be used to retrieve the process instance later via the query API.
      Throws:
      FlowableObjectNotFoundException - 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:
      FlowableObjectNotFoundException - 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.

      Parameters:
      processDefinitionId - the id of the process definition, cannot be null.
      variables - variables to be passed, can be null
      Throws:
      FlowableObjectNotFoundException - when no process definition is deployed with the given key.

    • startProcessInstanceWithForm

      ProcessInstance startProcessInstanceWithForm(String processDefinitionId, String outcome, Map<String,Object> variables, String processInstanceName)
      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.

      Only use this method when a form definition is attached to the start event of the provided process definition. This will expect the Flowable Form Engine to be enabled. A new form instance will be created after successfully starting a new process instance.

      Parameters:
      processDefinitionId - the id of the process definition, cannot be null.
      outcome - the form outcome of the start form, can be null.
      variables - variables to be passed, can be null
      processInstanceName - the name of the process instance to be started, can be null.
      Throws:
      FlowableObjectNotFoundException - when no process definition is deployed with the given id.

    • 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, FlowableException 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:
      FlowableException - if no subscription to a message with the given name exists
      Since:
      5.9

    • startProcessInstanceByMessageAndTenantId

      ProcessInstance startProcessInstanceByMessageAndTenantId(String messageName, String tenantId)
      Similar to startProcessInstanceByMessage(String), but with tenant context.

    • 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:
      FlowableException - if no subscription to a message with the given name exists
      Since:
      5.10

    • startProcessInstanceByMessageAndTenantId

      ProcessInstance startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, String tenantId)
      Similar to startProcessInstanceByMessage(String, String), but with tenant context.

    • 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:
      FlowableException - if no subscription to a message with the given name exists
      Since:
      5.9

    • startProcessInstanceByMessageAndTenantId

      ProcessInstance startProcessInstanceByMessageAndTenantId(String messageName, Map<String,Object> processVariables, String tenantId)
      Similar to startProcessInstanceByMessage(String, Map), but with tenant context.

    • 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:
      FlowableException - if no subscription to a message with the given name exists
      Since:
      5.9

    • startProcessInstanceByMessageAndTenantId

      ProcessInstance startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, Map<String,Object> processVariables, String tenantId)
      Similar to startProcessInstanceByMessage(String, String, Map), but with tenant context.

    • getStartFormModel

      FormInfo getStartFormModel(String processDefinitionId, String processInstanceId)
      Gets a Form model instance of the start form of a specific process definition or process instance
      Parameters:
      processDefinitionId - id of process definition for which the start form should be retrieved.
      processInstanceId - id of process instance for which the start form should be retrieved.

    • 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:
      FlowableObjectNotFoundException - when no process instance is found with the given id.

    • bulkDeleteProcessInstances

      void bulkDeleteProcessInstances(Collection<String> processInstanceIds, String deleteReason)
      Delete a collection of existing runtime process instance.
      Parameters:
      processInstanceIds - Set of ids of process instances to delete, cannot be null.
      deleteReason - reason for deleting, can be null.
      Throws:
      FlowableObjectNotFoundException - 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:
      FlowableObjectNotFoundException - when no execution exists with the given executionId.

    • trigger

      void trigger(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:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • triggerAsync

      void triggerAsync(String executionId)
      Sends an external trigger to an activity instance that is waiting inside the given execution. The waiting execution is notified asynchronously.
      Parameters:
      executionId - id of execution to signal, cannot be null.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • trigger

      void trigger(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:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • triggerAsync

      void triggerAsync(String executionId, Map<String,Object> processVariables)
      Sends an external trigger to an activity instance that is waiting inside the given execution. The waiting execution is notified asynchronously.
      Parameters:
      executionId - id of execution to signal, cannot be null.
      processVariables - a map of process variables
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • trigger

      void trigger(String executionId, Map<String,Object> processVariables, Map<String,Object> transientVariables)
      Similar to trigger(String, Map), but with an extra parameter that allows to pass transient variables.

    • evaluateConditionalEvents

      void evaluateConditionalEvents(String processInstanceId)
      Evaluate waiting conditional events (boundary, intermediate catch and event sub process start events) and trigger them if a condition evaluates to true.
      Parameters:
      processInstanceId - id of process instance, cannot be null.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given processInstanceId.

    • evaluateConditionalEvents

      void evaluateConditionalEvents(String processInstanceId, Map<String,Object> processVariables)
      Evaluate waiting conditional events (boundary, intermediate catch and event sub process start events) and trigger them if a condition evaluates to true.
      Parameters:
      processInstanceId - id of process instance, cannot be null.
      processVariables - a map of process variables to be set before evaluation
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given processInstanceId.

    • updateBusinessKey

      void updateBusinessKey(String processInstanceId, String businessKey)
      Updates the business key for the provided process instance
      Parameters:
      processInstanceId - id of the process instance to set the business key, cannot be null
      businessKey - new businessKey value

    • updateBusinessStatus

      void updateBusinessStatus(String processInstanceId, String businessStatus)
      Updates the business status for the provided process instance
      Parameters:
      processInstanceId - id of the process instance to set the business status, cannot be null
      businessStatus - new business status value

    • setOwner

      void setOwner(String processInstanceId, String userId)
      Set the new owner of a process instance.
      Parameters:
      processInstanceId - the id of the process to set its new owner
      userId - the id of the user to set as the new owner

    • removeOwner

      void removeOwner(String processInstanceId)
      Removes the owner of a process instance.
      Parameters:
      processInstanceId - the id of the process to remove the owner from

    • setAssignee

      void setAssignee(String processInstanceId, String userId)
      Set the new assignee of a process instance.
      Parameters:
      processInstanceId - the id of the process to set its new assignee
      userId - the id of the user to set as the new assignee

    • removeAssignee

      void removeAssignee(String processInstanceId)
      Removes the assignee of a process instance.
      Parameters:
      processInstanceId - the id of the process to remove the assignee from

    • addUserIdentityLink

      void addUserIdentityLink(String processInstanceId, String userId, String identityLinkType)
      Involves a user with a process instance. The type of identity link is defined by the given identityLinkType.
      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).
      Throws:
      FlowableObjectNotFoundException - when the process instance doesn't exist.

    • addGroupIdentityLink

      void addGroupIdentityLink(String processInstanceId, String groupId, String identityLinkType)
      Involves a group with a process instance. The type of identityLink is defined by the given identityLink.
      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).
      Throws:
      FlowableObjectNotFoundException - when the process instance or group doesn't exist.

    • addParticipantUser

      void addParticipantUser(String processInstanceId, String userId)
      Convenience shorthand for addUserIdentityLink(String, String, String); with type IdentityLinkType.PARTICIPANT
      Parameters:
      processInstanceId - id of the process instance, cannot be null.
      userId - id of the user to use as candidate, cannot be null.
      Throws:
      FlowableObjectNotFoundException - when the task or user doesn't exist.

    • addParticipantGroup

      void addParticipantGroup(String processInstanceId, String groupId)
      Convenience shorthand for addGroupIdentityLink(String, String, String); with type IdentityLinkType.PARTICIPANT
      Parameters:
      processInstanceId - id of the process instance, cannot be null.
      groupId - id of the group to use as candidate, cannot be null.
      Throws:
      FlowableObjectNotFoundException - when the task or group doesn't exist.

    • deleteParticipantUser

      void deleteParticipantUser(String processInstanceId, String userId)
      Convenience shorthand for deleteUserIdentityLink(String, String, String); with type IdentityLinkType.PARTICIPANT
      Parameters:
      processInstanceId - id of the process instance, cannot be null.
      userId - id of the user to use as candidate, cannot be null.
      Throws:
      FlowableObjectNotFoundException - when the task or user doesn't exist.

    • deleteParticipantGroup

      void deleteParticipantGroup(String processInstanceId, String groupId)
      Convenience shorthand for deleteGroupIdentityLink(String, String, String); with type IdentityLinkType.PARTICIPANT
      Parameters:
      processInstanceId - id of the process instance, cannot be null.
      groupId - id of the group to use as candidate, cannot be null.
      Throws:
      FlowableObjectNotFoundException - when the task or group doesn't exist.

    • deleteUserIdentityLink

      void deleteUserIdentityLink(String processInstanceId, String userId, String identityLinkType)
      Removes the association between a user and a process instance for the given identityLinkType.
      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).
      Throws:
      FlowableObjectNotFoundException - when the task or user doesn't exist.

    • deleteGroupIdentityLink

      void deleteGroupIdentityLink(String processInstanceId, String groupId, String identityLinkType)
      Removes the association between a group and a process instance for the given identityLinkType.
      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).
      Throws:
      FlowableObjectNotFoundException - when the task or group doesn't exist.

    • getIdentityLinksForProcessInstance

      List<IdentityLink> getIdentityLinksForProcessInstance(String instanceId)
      Retrieves the IdentityLinks associated with the given process instance. Such an IdentityLink informs how a certain user is involved with a process instance.

    • getEntityLinkChildrenForProcessInstance

      List<EntityLink> getEntityLinkChildrenForProcessInstance(String instanceId)
      Retrieves the EntityLinks associated with the given process instance.

    • getEntityLinkChildrenWithSameRootAsProcessInstance

      List<EntityLink> getEntityLinkChildrenWithSameRootAsProcessInstance(String instanceId)
      Retrieves all the EntityLinks associated with the same root as the given process instance.

    • getEntityLinkChildrenForTask

      List<EntityLink> getEntityLinkChildrenForTask(String taskId)
      Retrieves the EntityLinks associated with the given task.

    • getEntityLinkParentsForProcessInstance

      List<EntityLink> getEntityLinkParentsForProcessInstance(String instanceId)
      Retrieves the EntityLinks where the given process instance is referenced.

    • getEntityLinkParentsForTask

      List<EntityLink> getEntityLinkParentsForTask(String taskId)
      Retrieves the EntityLinks where the given task is referenced.

    • 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:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getVariableInstances

      Map<String,VariableInstance> getVariableInstances(String executionId)
      All variables visible from the given execution scope (including parent scopes).
      Parameters:
      executionId - id of execution, cannot be null.
      Returns:
      the variable instances or an empty map if no such variables are found.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getVariableInstancesByExecutionIds

      List<VariableInstance> getVariableInstancesByExecutionIds(Set<String> executionIds)
      All variables visible from the given execution scope (including parent scopes).
      Parameters:
      executionIds - ids of execution, cannot be null.
      Returns:
      the variables.

    • 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:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getVariableInstancesLocal

      Map<String,VariableInstance> getVariableInstancesLocal(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 getVariableInstancesLocal(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:
      FlowableObjectNotFoundException - 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:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getVariableInstances

      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).
      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:
      FlowableObjectNotFoundException - 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:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getVariableInstancesLocal

      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.
      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:
      FlowableObjectNotFoundException - 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:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getVariableInstance

      VariableInstance getVariableInstance(String executionId, String variableName)
      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.
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getVariable

      <T> T getVariable(String executionId, String variableName, Class<T> variableClass)
      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
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • hasVariable

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

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

    • getVariableInstanceLocal

      VariableInstance getVariableInstanceLocal(String executionId, String variableName)
      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.
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getVariableLocal

      <T> T getVariableLocal(String executionId, String variableName, Class<T> variableClass)
      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.

    • hasVariableLocal

      boolean hasVariableLocal(String executionId, String variableName)
      Check whether or not this execution has a local variable set with the given name.

    • setVariable

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

      The variable is set according to the algorithm as documented for VariableScope.setVariable(String, Object).

      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:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.
      See Also:

    • 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:
      FlowableObjectNotFoundException - 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).

      Variables are set according to the algorithm as documented for VariableScope.setVariables(Map), applied separately to each variable.

      Parameters:
      executionId - id of the execution, cannot be null.
      variables - map containing name (key) and value of variables, can be null.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.
      See Also:

    • 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:
      FlowableObjectNotFoundException - 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.

    • createVariableInstanceQuery

      VariableInstanceQuery createVariableInstanceQuery()
      Creates a new programmatic query to search for VariableInstances.

    • createNativeVariableInstanceQuery

      NativeVariableInstanceQuery createNativeVariableInstanceQuery()
      Returns a new NativeQuery for variable instances.

    • getDataObjects

      Map<String,DataObject> getDataObjects(String executionId)
      All DataObjects visible from the given execution scope (including parent scopes).
      Parameters:
      executionId - id of execution, cannot be null.
      Returns:
      the DataObjects or an empty map if no such variables are found.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObjects

      Map<String,DataObject> getDataObjects(String executionId, String locale, boolean withLocalizationFallback)
      All DataObjects visible from the given execution scope (including parent scopes).
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObjectsLocal

      Map<String,DataObject> getDataObjectsLocal(String executionId)
      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 getDataObjectsLocal(String, Collection) for better performance.
      Parameters:
      executionId - id of execution, cannot be null.
      Returns:
      the DataObjects or an empty map if no DataObjects are found.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObjectsLocal

      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. If you have many local DataObjects and you only need a few, consider using getDataObjectsLocal(String, Collection) for better performance.
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObjects

      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).
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObjects

      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).
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObjectsLocal

      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.
      Parameters:
      executionId - id of execution, cannot be null.
      dataObjects - the collection of DataObject names that should be retrieved.
      Returns:
      the DataObjects or an empty map if no DataObjects are found.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObjectsLocal

      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.
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObject

      DataObject getDataObject(String executionId, String dataObject)
      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.
      Parameters:
      executionId - id of execution, cannot be null.
      dataObject - name of DataObject, cannot be null.
      Returns:
      the DataObject or null if the variable is undefined.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObject

      DataObject getDataObject(String executionId, String dataObjectName, String locale, boolean withLocalizationFallback)
      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.
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObjectLocal

      DataObject getDataObjectLocal(String executionId, String dataObjectName)
      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.
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • getDataObjectLocal

      DataObject getDataObjectLocal(String executionId, String dataObjectName, String locale, boolean withLocalizationFallback)
      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.
      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.
      Throws:
      FlowableObjectNotFoundException - when no execution is found for the given executionId.

    • 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

    • createActivityInstanceQuery

      ActivityInstanceQuery createActivityInstanceQuery()
      Creates a new ActivityInstanceQuery instance, that can be used to query activities in the currently running process instances.

    • createNativeActivityInstanceQuery

      NativeActivityInstanceQuery createNativeActivityInstanceQuery()
      creates a new NativeActivityInstanceQuery to query ActivityInstances which are included in the cuby SQL directly.

    • createEventSubscriptionQuery

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

    • suspendProcessInstanceById

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

      If a process instance is in state suspended, flowable 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.

      Throws:
      FlowableObjectNotFoundException - if no such processInstance can be found.
      FlowableException - the process instance is already in state suspended.

    • activateProcessInstanceById

      void activateProcessInstanceById(String processInstanceId)
      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.

      Throws:
      FlowableObjectNotFoundException - if no such processInstance can be found.
      FlowableException - if the process instance is already in state active.

    • 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

    • signalEventReceivedWithTenantId

      void signalEventReceivedWithTenantId(String signalName, String tenantId)
      Similar to signalEventReceived(String), but within the context of one tenant.

    • signalEventReceivedAsync

      void signalEventReceivedAsync(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.

      Parameters:
      signalName - the name of the signal event

    • signalEventReceivedAsyncWithTenantId

      void signalEventReceivedAsyncWithTenantId(String signalName, String tenantId)
      Similar to signalEventReceivedAsync(String), but within the context of one tenant.

    • 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)

    • signalEventReceivedWithTenantId

      void signalEventReceivedWithTenantId(String signalName, Map<String,Object> processVariables, String tenantId)
      Similar to signalEventReceived(String, Map), but within the context of one tenant.

    • 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:
      FlowableObjectNotFoundException - if no such execution exists.
      FlowableException - 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:
      FlowableObjectNotFoundException - if no such execution exists.
      FlowableException - if the execution has not subscribed to the signal

    • signalEventReceivedAsync

      void signalEventReceivedAsync(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 asynchronously.
      Parameters:
      signalName - the name of the signal event
      executionId - the id of the execution to deliver the signal to
      Throws:
      FlowableObjectNotFoundException - if no such execution exists.
      FlowableException - 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:
      FlowableObjectNotFoundException - if no such execution exists.
      FlowableException - 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.

      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
      Variables are set according to the algorithm as documented for VariableScope.setVariables(Map), applied separately to each variable.
      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:
      FlowableObjectNotFoundException - if no such execution exists.
      FlowableException - if the execution has not subscribed to the signal
      See Also:

    • messageEventReceivedAsync

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

      The waiting execution is notified asynchronously.

      Parameters:
      messageName - the name of the message event
      executionId - the id of the execution to deliver the message to
      Throws:
      FlowableObjectNotFoundException - if no such execution exists.
      FlowableException - if the execution has not subscribed to the signal

    • addEventListener

      void addEventListener(FlowableEventListener listenerToAdd)
      Adds an event-listener which will be notified of ALL events by the dispatcher.
      Parameters:
      listenerToAdd - the listener to add

    • addEventListener

      void addEventListener(FlowableEventListener listenerToAdd, FlowableEngineEventType... types)
      Adds an event-listener which will only be notified when an event occurs, which type is in the given types.
      Parameters:
      listenerToAdd - the listener to add
      types - types of events the listener should be notified for

    • removeEventListener

      void removeEventListener(FlowableEventListener listenerToRemove)
      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.
      Parameters:
      listenerToRemove - listener to remove

    • dispatchEvent

      void dispatchEvent(FlowableEvent event)
      Dispatches the given event to any listeners that are registered.
      Parameters:
      event - event to dispatch.
      Throws:
      FlowableException - if an exception occurs when dispatching the event or when the FlowableEventDispatcher is disabled.
      FlowableIllegalArgumentException - when the given event is not suitable for dispatching.

    • addEventRegistryConsumer

      void addEventRegistryConsumer(EventRegistryEventConsumer eventConsumer)

    • removeEventRegistryConsumer

      void removeEventRegistryConsumer(EventRegistryEventConsumer eventConsumer)

    • createProcessInstanceStartEventSubscriptionBuilder

      ProcessInstanceStartEventSubscriptionBuilder createProcessInstanceStartEventSubscriptionBuilder()
      Creates a new event subscription builder to register a subscription to start a new process instance based on an event with a particular set of correlation parameter values. In order for this to work, the process definition needs to have an event-registry based start event with a dynamic, manual subscription based behavior and the registered correlation parameter values within the builder need to be based on actual correlation parameter definitions within the event model the start event is based on. Register one or more correlation parameter value with in the builder before invoking the ProcessInstanceStartEventSubscriptionBuilder.subscribe() method to create and register the subscription.
      Returns:
      the subscription builder

    • createProcessInstanceStartEventSubscriptionModificationBuilder

      ProcessInstanceStartEventSubscriptionModificationBuilder createProcessInstanceStartEventSubscriptionModificationBuilder()
      Creates a new event subscription modification builder to modify one or more previously registered process start event subscriptions based on a particular process definition and with an optional combination of correlation parameter values.
      Returns:
      the subscription modification builder

    • createProcessInstanceStartEventSubscriptionDeletionBuilder

      ProcessInstanceStartEventSubscriptionDeletionBuilder createProcessInstanceStartEventSubscriptionDeletionBuilder()
      Creates a new event subscription deletion builder delete one or more previously registered process start event subscriptions based on a particular process definition and with an optional combination of correlation parameter values.
      Returns:
      the subscription deletion builder

    • setProcessInstanceName

      void setProcessInstanceName(String processInstanceId, String name)
      Sets the name for the process instance with the given id.
      Parameters:
      processInstanceId - id of the process instance to update
      name - new name for the process instance
      Throws:
      FlowableObjectNotFoundException - when the given process instance does not exist.

    • getAdhocSubProcessExecutions

      List<Execution> getAdhocSubProcessExecutions(String processInstanceId)
      Gets executions with an adhoc sub process as current flow element
      Parameters:
      processInstanceId - id of the process instance that is used to search for child executions
      Returns:
      a list of executions

    • getEnabledActivitiesFromAdhocSubProcess

      List<FlowNode> getEnabledActivitiesFromAdhocSubProcess(String executionId)
      Gets enabled activities from ad-hoc sub process
      Parameters:
      executionId - id of the execution that has an ad-hoc sub process as current flow element
      Returns:
      a list of enabled activities

    • executeActivityInAdhocSubProcess

      Execution executeActivityInAdhocSubProcess(String executionId, String activityId)
      Executes an activity in a ad-hoc sub process
      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

      void completeAdhocSubProcess(String executionId)
      Completes the ad-hoc sub process
      Parameters:
      executionId - id of the execution that has an ad-hoc sub process as current flow element

    • createChangeActivityStateBuilder

      ChangeActivityStateBuilder createChangeActivityStateBuilder()
      Create a ChangeActivityStateBuilder, that allows to set various options for changing the state of a process instance.

    • addMultiInstanceExecution

      Execution addMultiInstanceExecution(String activityId, String parentExecutionId, Map<String,Object> executionVariables)
      Adds a new execution to a running multi-instance parent execution
      Parameters:
      activityId - id of the multi-instance activity (id attribute in the BPMN XML)
      parentExecutionId - can be the process instance id, in case there's one multi-instance execution for the provided activity id. In case of multiple multi-instance executions with the same activity id this can be a specific parent execution id.
      executionVariables - variables to be set on as local variable on the newly created multi-instance execution
      Returns:
      the newly created multi-instance execution

    • deleteMultiInstanceExecution

      void deleteMultiInstanceExecution(String executionId, boolean executionIsCompleted)
      Deletes a multi-instance execution
      Parameters:
      executionId - id of the multi-instance execution to be deleted
      executionIsCompleted - defines if the deleted execution should be marked as completed on the parent multi-instance execution

    • getProcessInstanceEvents

      List<Event> getProcessInstanceEvents(String processInstanceId)
      The all events related to the given Process Instance.