ActionRuntimeService (Flowable Work 3.10.0)

All Known Implementing Classes:

ActionRuntimeServiceImpl
```
public interface ActionRuntimeService
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ActionTypeLink`	`addActionInstanceTypeLink(String actionInstanceId, String type, String linkValue)` Adds a new `ActionTypeLink` for the given action instance id.
`ActionInstanceBuilder`	`createActionInstanceBuilder()` Starts creating a new action instance
`ActionInstanceQuery`	`createActionInstanceQuery()` Query action instances
`ActionLinkQuery`	`createActionLinkQuery()` Query action links
`ExecuteActionInstanceBuilder`	`createExecuteActionInstanceBuilder()` Executes a new action instance
`void`	`deleteActionInstance(String actionInstanceId)` delete an action instance by id
`void`	`deleteActionInstanceTypeLink(String actionInstanceTypeLinkId)` Deletes an `ActionTypeLink` for the given action instance link id.
`List<ActionInstance>`	`findActionInstancesForScopeIdAndSubScopeId(String scopeType, String scopeId, String subScopeId, boolean includeDeletedFromCache)`
`ScopedObjectActionData`	`findScopedObjectActionData(ScopedObjectActionQuery scopedObjectActionQuery)` Finds all `ActionDefinition` and `ActionInstance` instances that match the scope information passed in the `ScopedObjectActionQuery` parameters and returns these as a `ScopedObjectActionData` instance.
`List<IdentityLink>`	`getActionInstanceIdentityLinks(String actionInstanceId)`
`List<ActionTypeLink>`	`getActionInstanceTypeLinks(String actionInstanceId)` Returns `ActionTypeLink`s for the given action instance id.
`FormInfo`	`getFormInfo(String actionInstanceId)`
`Map<String,Object>`	`getVariables(String actionInstanceId)`
`void`	`migrateActionTypeLinks()` migrate action type links

- Method Detail
  - createActionInstanceBuilder
```
ActionInstanceBuilder createActionInstanceBuilder()
```
    Starts creating a new action instance
  - createExecuteActionInstanceBuilder
```
ExecuteActionInstanceBuilder createExecuteActionInstanceBuilder()
```
    Executes a new action instance
  - findScopedObjectActionData
```
ScopedObjectActionData findScopedObjectActionData(ScopedObjectActionQuery scopedObjectActionQuery)
```
    Finds all ActionDefinition and ActionInstance instances that match the scope information passed in the ScopedObjectActionQuery parameters and returns these as a ScopedObjectActionData instance. A 'scope' is a combination of a type (e.g. conversation) and identifiers (e.g the conversationId). Typically an action is created for a certain scope (e.g. a certain conversation), so the return result will contain all ActionInstance results for that particular query. Some action definitions are applicable for the scope (e.g. the action to join a conversation), but don't have an action instance, as they can be repeated many times and there is no such thing as 'one action' to execute. This is why the result also contains these ActionDefinitions that match the given scope. All definitions and instances found this way are put through the list of filters that are registered on the action engine configuration. Other engines (engage, cmmn, process, etc.) should inject scope-specific filters into the engine.
  - getFormInfo
```
FormInfo getFormInfo(String actionInstanceId)
```
  - getActionInstanceIdentityLinks
```
List<IdentityLink> getActionInstanceIdentityLinks(String actionInstanceId)
```
  - getVariables
```
Map<String,Object> getVariables(String actionInstanceId)
```
  - findActionInstancesForScopeIdAndSubScopeId
```
List<ActionInstance> findActionInstancesForScopeIdAndSubScopeId(String scopeType,
                                                                String scopeId,
                                                                String subScopeId,
                                                                boolean includeDeletedFromCache)
```
    Parameters:
    
    includeDeletedFromCache - Only set this to true for very specific use cases where the action instance could be deleted prior and it's still needed.
  - createActionInstanceQuery
```
ActionInstanceQuery createActionInstanceQuery()
```
    Query action instances
  - createActionLinkQuery
```
ActionLinkQuery createActionLinkQuery()
```
    Query action links
  - getActionInstanceTypeLinks
```
List<ActionTypeLink> getActionInstanceTypeLinks(String actionInstanceId)
```
    Returns ActionTypeLinks for the given action instance id.
  - addActionInstanceTypeLink
```
ActionTypeLink addActionInstanceTypeLink(String actionInstanceId,
                                         String type,
                                         String linkValue)
```
    Adds a new ActionTypeLink for the given action instance id.
  - deleteActionInstanceTypeLink
```
void deleteActionInstanceTypeLink(String actionInstanceTypeLinkId)
```
    Deletes an ActionTypeLink for the given action instance link id.
  - deleteActionInstance
```
void deleteActionInstance(String actionInstanceId)
```
    delete an action instance by id
  - migrateActionTypeLinks
```
void migrateActionTypeLinks()
```
    migrate action type links

Interface ActionRuntimeService

Method Summary

Method Detail

createActionInstanceBuilder

createExecuteActionInstanceBuilder

findScopedObjectActionData

getFormInfo

getActionInstanceIdentityLinks

getVariables

findActionInstancesForScopeIdAndSubScopeId

createActionInstanceQuery

createActionLinkQuery

getActionInstanceTypeLinks

addActionInstanceTypeLink

deleteActionInstanceTypeLink

deleteActionInstance

migrateActionTypeLinks