All Known Implementing Classes:: ActionRuntimeServiceImpl

public interface ActionRuntimeService

Method Summary

Modifier and Type	Method	Description
`ActionTypeLink`	`addActionInstanceTypeLink(java.lang.String actionInstanceId, java.lang.String type, java.lang.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(java.lang.String actionInstanceId)`	delete an action instance by id
`void`	`deleteActionInstanceTypeLink(java.lang.String actionInstanceTypeLinkId)`	Deletes an `ActionTypeLink` for the given action instance link id.
`java.util.List<ActionInstance>`	`findActionInstancesForScopeIdAndSubScopeId(java.lang.String scopeType, java.lang.String scopeId, java.lang.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.
`java.util.List<org.flowable.identitylink.api.IdentityLink>`	`getActionInstanceIdentityLinks(java.lang.String actionInstanceId)`
`java.util.List<ActionTypeLink>`	`getActionInstanceTypeLinks(java.lang.String actionInstanceId)`	Returns `ActionTypeLink`s for the given action instance id.
`org.flowable.form.api.FormInfo`	`getFormInfo(java.lang.String actionInstanceId)`
`java.util.Map<java.lang.String,java.lang.Object>`	`getVariables(java.lang.String actionInstanceId)`
`void`	`migrateActionTypeLinks()`	migrate action type links

Method Details
- 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
  
  org.flowable.form.api.FormInfo getFormInfo(java.lang.String actionInstanceId)
- getActionInstanceIdentityLinks
  
  java.util.List<org.flowable.identitylink.api.IdentityLink> getActionInstanceIdentityLinks(java.lang.String actionInstanceId)
- getVariables
  
  java.util.Map<java.lang.String,java.lang.Object> getVariables(java.lang.String actionInstanceId)
- findActionInstancesForScopeIdAndSubScopeId
  
  java.util.List<ActionInstance> findActionInstancesForScopeIdAndSubScopeId(java.lang.String scopeType, java.lang.String scopeId, java.lang.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
  
  java.util.List<ActionTypeLink> getActionInstanceTypeLinks(java.lang.String actionInstanceId)
  
  Returns ActionTypeLinks for the given action instance id.
- addActionInstanceTypeLink
  
  ActionTypeLink addActionInstanceTypeLink(java.lang.String actionInstanceId, java.lang.String type, java.lang.String linkValue)
  
  Adds a new ActionTypeLink for the given action instance id.
- deleteActionInstanceTypeLink
  
  void deleteActionInstanceTypeLink(java.lang.String actionInstanceTypeLinkId)
  
  Deletes an ActionTypeLink for the given action instance link id.
- deleteActionInstance
  
  void deleteActionInstance(java.lang.String actionInstanceId)
  
  delete an action instance by id
- migrateActionTypeLinks
  
  void migrateActionTypeLinks()
  
  migrate action type links

Interface ActionRuntimeService

Method Summary

Method Details