Package com.flowable.action.api.runtime
Interface ExecuteActionInstanceBuilder
-
- All Known Implementing Classes:
ExecuteActionInstanceBuilderImpl
public interface ExecuteActionInstanceBuilderHelper for executing and Action instance. An instance can be obtained throughActionRuntimeService. actionInstance, actionDefinitionId or actionDefinitionKey should be set before callingexecute()to execute an action instance.- Author:
- Tijs Rademakers
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ExecuteActionInstanceBuilderactionDefinitionId(String actionDefinitionId)Set the id of the action definitionExecuteActionInstanceBuilderactionDefinitionKey(String actionDefinitionKey)Set the key of the action definition, latest version of the action definition with the given key.ExecuteActionInstanceBuilderactionInstanceId(String actionInstanceId)Set the id of the action instanceActionInstanceExecutionResultexecute()Executes the action instanceExecuteActionInstanceBuildername(String name)Set the name of the action instanceExecuteActionInstanceBuilderpayload(Map<String,Object> payload)Set the payload of the action to be used for storing the form instance or executing the botExecuteActionInstanceBuilderscopeDefinitionId(String scopeDefinitionId)Set the scope definition id of the action instanceExecuteActionInstanceBuilderscopeId(String scopeId)Set the scope id of the action instanceExecuteActionInstanceBuilderscopeType(String scopeType)Set the scope type of the action instanceExecuteActionInstanceBuildersubScopeId(String subScopeId)Sets the sub scope id of the action instanceExecuteActionInstanceBuildertenantId(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 nullFlowableObjectNotFoundException- when no action instance or definition is deployed with the given actionInstanceId, actionDefinitionKey or actionDefinitionId
-
-