Package com.flowable.action.api.runtime

Interface ActionInstanceBuilder

All Known Implementing Classes:

ActionInstanceBuilderImpl

public interface ActionInstanceBuilder

Helper for starting new Action instance. An instance can be obtained through the ActionRuntimeService. actionDefinitionId or actionDefinitionKey should be set before calling start() to start an action instance.

Author:

Tijs Rademakers

Method Summary

Modifier and Type	Method	Description
ActionInstanceBuilder	actionDefinitionId(String actionDefinitionId)	Set the id of the action definition
ActionInstanceBuilder	actionDefinitionKey(String actionDefinitionKey)	Set the key of the action definition, latest version of the action definition with the given key.
ActionInstanceBuilder	addActionLink(String scopeId, String scopeType)	Adds one ActionLink for this ActionInstance.
ActionInstanceBuilder	addActionTypeLink(String type, String linkValue)	Adds one ActionTypeLink for this ActionInstance.
ActionInstanceBuilder	addGroupIdentityLink(String groupId, String identityLinkType)	Adds a group identity link to the action instance.
ActionInstanceBuilder	addUserIdentityLink(String userId, String identityLinkType)	Adds an user identity link to the action instance.
ActionInstanceBuilder	formInstanceId(String formInstanceId)	Set the form instance id of the action instance
ActionInstanceBuilder	formKey(String formKey)	Set the form key of the action instance
ActionInstanceBuilder	formParentDeploymentId(String formParentDeploymentId)	The parent deployment id that should be used for the form key.
ActionInstanceBuilder	icon(String icon)	Set the icon of the action instance
ActionInstanceBuilder	name(String name)	Set the name of the action instance
ActionInstanceBuilder	priority(Integer priority)	The priority for the action instance.
ActionInstanceBuilder	scopeDefinitionId(String scopeDefinitionId)	Set the scope definition id of the action instance
ActionInstanceBuilder	scopeId(String scopeId)	Set the scope id of the action instance
ActionInstanceBuilder	scopeType(String scopeType)	Set the scope type of the action instance
ActionInstance	start()	Start the action instance
ActionInstanceBuilder	subScopeId(String subScopeId)	Set the sub scope id of the action instance
ActionInstanceBuilder	tenantId(String tenantId)	Set the tenantId of process instance

Method Details

actionDefinitionId

ActionInstanceBuilder actionDefinitionId(String actionDefinitionId)

Set the id of the action definition

actionDefinitionKey

ActionInstanceBuilder 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

ActionInstanceBuilder name(String name)

Set the name of the action instance

scopeId

ActionInstanceBuilder scopeId(String scopeId)

Set the scope id of the action instance

subScopeId

ActionInstanceBuilder subScopeId(String subScopeId)

Set the sub scope id of the action instance

scopeType

ActionInstanceBuilder scopeType(String scopeType)

Set the scope type of the action instance

scopeDefinitionId

ActionInstanceBuilder scopeDefinitionId(String scopeDefinitionId)

Set the scope definition id of the action instance

formInstanceId

ActionInstanceBuilder formInstanceId(String formInstanceId)

Set the form instance id of the action instance

formKey

ActionInstanceBuilder formKey(String formKey)

Set the form key of the action instance

formParentDeploymentId

ActionInstanceBuilder formParentDeploymentId(String formParentDeploymentId)

The parent deployment id that should be used for the form key.

priority

ActionInstanceBuilder priority(Integer priority)

The priority for the action instance.

tenantId

ActionInstanceBuilder tenantId(String tenantId)

Set the tenantId of process instance

addUserIdentityLink

ActionInstanceBuilder addUserIdentityLink(String userId,
 String identityLinkType)

Adds an user identity link to the action instance.

addGroupIdentityLink

ActionInstanceBuilder addGroupIdentityLink(String groupId,
 String identityLinkType)

Adds a group identity link to the action instance.

addActionLink

ActionInstanceBuilder addActionLink(String scopeId,
 String scopeType)

Adds one ActionLink for this ActionInstance.

addActionTypeLink

ActionInstanceBuilder addActionTypeLink(String type,
 String linkValue)

Adds one ActionTypeLink for this ActionInstance.

icon

ActionInstanceBuilder icon(String icon)

Set the icon of the action instance

start

ActionInstance start()

Start the action instance

Throws:

FlowableIllegalArgumentException - if actionDefinitionKey and actionDefinitionId are null

FlowableObjectNotFoundException - when no action definition is deployed with the given actionDefinitionKey or actionDefinitionId