Package com.flowable.action.api.runtime

Interface ExecuteActionInstanceBuilder

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

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

Method Details

actionInstanceId

ExecuteActionInstanceBuilder actionInstanceId(java.lang.String actionInstanceId)

Set the id of the action instance

actionDefinitionId

ExecuteActionInstanceBuilder actionDefinitionId(java.lang.String actionDefinitionId)

Set the id of the action definition

actionDefinitionKey

ExecuteActionInstanceBuilder actionDefinitionKey(java.lang.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(java.lang.String name)

Set the name of the action instance

scopeId

ExecuteActionInstanceBuilder scopeId(java.lang.String scopeId)

Set the scope id of the action instance

subScopeId

ExecuteActionInstanceBuilder subScopeId(java.lang.String subScopeId)

Sets the sub scope id of the action instance

scopeType

ExecuteActionInstanceBuilder scopeType(java.lang.String scopeType)

Set the scope type of the action instance

scopeDefinitionId

ExecuteActionInstanceBuilder scopeDefinitionId(java.lang.String scopeDefinitionId)

Set the scope definition id of the action instance

payload

ExecuteActionInstanceBuilder payload(java.util.Map<java.lang.String,java.lang.Object> payload)

Set the payload of the action to be used for storing the form instance or executing the bot

tenantId

ExecuteActionInstanceBuilder tenantId(java.lang.String tenantId)

Set the tenantId of process instance

execute

ActionInstanceExecutionResult execute()

Executes the action instance

Throws:

org.flowable.common.engine.api.FlowableIllegalArgumentException - if actionInstanceId, actionDefinitionKey and actionDefinitionId are null

org.flowable.common.engine.api.FlowableObjectNotFoundException - when no action instance or definition is deployed with the given actionInstanceId, actionDefinitionKey or actionDefinitionId