ExecuteActionInstanceBuilder (Flowable Work 3.10.0)

All Known Implementing Classes:

ExecuteActionInstanceBuilderImpl
```
public interface ExecuteActionInstanceBuilder
```
Helper for executing and Action instance. An instance can be obtained through ActionRuntimeService. actionInstance, actionDefinitionId or actionDefinitionKey should be set before calling execute() to execute an action instance.

Author:

Tijs Rademakers

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ExecuteActionInstanceBuilder`	`actionDefinitionId(String actionDefinitionId)` Set the id of the action definition
`ExecuteActionInstanceBuilder`	`actionDefinitionKey(String actionDefinitionKey)` Set the key of the action definition, latest version of the action definition with the given key.
`ExecuteActionInstanceBuilder`	`actionInstanceId(String actionInstanceId)` Set the id of the action instance
`ActionInstanceExecutionResult`	`execute()` Executes the action instance
`ExecuteActionInstanceBuilder`	`name(String name)` Set the name of the action instance
`ExecuteActionInstanceBuilder`	`payload(Map<String,Object> payload)` Set the payload of the action to be used for storing the form instance or executing the bot
`ExecuteActionInstanceBuilder`	`scopeDefinitionId(String scopeDefinitionId)` Set the scope definition id of the action instance
`ExecuteActionInstanceBuilder`	`scopeId(String scopeId)` Set the scope id of the action instance
`ExecuteActionInstanceBuilder`	`scopeType(String scopeType)` Set the scope type of the action instance
`ExecuteActionInstanceBuilder`	`subScopeId(String subScopeId)` Sets the sub scope id of the action instance
`ExecuteActionInstanceBuilder`	`tenantId(String tenantId)` Set the tenantId of process instance

- Method Detail
  - actionInstanceId
```
ExecuteActionInstanceBuilder actionInstanceId(String actionInstanceId)
```
    Set the id of the action instance
  - actionDefinitionId
```
ExecuteActionInstanceBuilder actionDefinitionId(String actionDefinitionId)
```
    Set the id of the action definition
  - actionDefinitionKey
```
ExecuteActionInstanceBuilder actionDefinitionKey(String actionDefinitionKey)
```
    Set the key of the action definition, latest version of the action definition with the given key. If actionDefinitionId was set this will be ignored
  - name
```
ExecuteActionInstanceBuilder name(String name)
```
    Set the name of the action instance
  - scopeId
```
ExecuteActionInstanceBuilder scopeId(String scopeId)
```
    Set the scope id of the action instance
  - subScopeId
```
ExecuteActionInstanceBuilder subScopeId(String subScopeId)
```
    Sets the sub scope id of the action instance
  - scopeType
```
ExecuteActionInstanceBuilder scopeType(String scopeType)
```
    Set the scope type of the action instance
  - scopeDefinitionId
```
ExecuteActionInstanceBuilder scopeDefinitionId(String scopeDefinitionId)
```
    Set the scope definition id of the action instance
  - payload
```
ExecuteActionInstanceBuilder payload(Map<String,Object> payload)
```
    Set the payload of the action to be used for storing the form instance or executing the bot
  - tenantId
```
ExecuteActionInstanceBuilder tenantId(String tenantId)
```
    Set the tenantId of process instance
  - execute
```
ActionInstanceExecutionResult execute()
```
    Executes the action instance
    
    Throws:
    
    FlowableIllegalArgumentException - if actionInstanceId, actionDefinitionKey and actionDefinitionId are null
    
    FlowableObjectNotFoundException - when no action instance or definition is deployed with the given actionInstanceId, actionDefinitionKey or actionDefinitionId

Interface ExecuteActionInstanceBuilder

Method Summary

Method Detail

actionInstanceId

actionDefinitionId

actionDefinitionKey

name

scopeId

subScopeId

scopeType

scopeDefinitionId

payload

tenantId

execute