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 Detail

      • actionDefinitionId

        ActionInstanceBuilder actionDefinitionId​(java.lang.String actionDefinitionId)
        Set the id of the action definition

      • actionDefinitionKey

        ActionInstanceBuilder 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

      • scopeId

        ActionInstanceBuilder scopeId​(java.lang.String scopeId)
        Set the scope id of the action instance

      • subScopeId

        ActionInstanceBuilder subScopeId​(java.lang.String subScopeId)
        Set the sub scope id of the action instance

      • scopeType

        ActionInstanceBuilder scopeType​(java.lang.String scopeType)
        Set the scope type of the action instance

      • scopeDefinitionId

        ActionInstanceBuilder scopeDefinitionId​(java.lang.String scopeDefinitionId)
        Set the scope definition id of the action instance

      • formInstanceId

        ActionInstanceBuilder formInstanceId​(java.lang.String formInstanceId)
        Set the form instance id of the action instance

      • formKey

        ActionInstanceBuilder formKey​(java.lang.String formKey)
        Set the form key of the action instance

      • formParentDeploymentId

        ActionInstanceBuilder formParentDeploymentId​(java.lang.String formParentDeploymentId)
        The parent deployment id that should be used for the form key.

      • priority

        ActionInstanceBuilder priority​(java.lang.Integer priority)
        The priority for the action instance.

      • tenantId

        ActionInstanceBuilder tenantId​(java.lang.String tenantId)
        Set the tenantId of process instance

      • addUserIdentityLink

        ActionInstanceBuilder addUserIdentityLink​(java.lang.String userId,
                                          java.lang.String identityLinkType)
        Adds an user identity link to the action instance.

      • addGroupIdentityLink

        ActionInstanceBuilder addGroupIdentityLink​(java.lang.String groupId,
                                           java.lang.String identityLinkType)
        Adds a group identity link to the action instance.

      • start

        ActionInstance start()
        Start the action instance
        Throws:
        org.flowable.common.engine.api.FlowableIllegalArgumentException - if actionDefinitionKey and actionDefinitionId are null
        org.flowable.common.engine.api.FlowableObjectNotFoundException - when no action definition is deployed with the given actionDefinitionKey or actionDefinitionId