All Known Implementing Classes:: ActionRepositoryServiceImpl

public interface ActionRepositoryService

Method Summary

Modifier and Type	Method	Description
`ActionDefinitionLink`	`addActionDefinitionLink(java.lang.String actionDefinitionId, java.lang.String type, java.lang.String linkValue)`	Adds a new `ActionDefinitionLink` for the given action definition id.
`java.lang.String`	`convertActionDefinitionModelToJson(java.lang.String actionDefinitionId)`	Returns the `ActionDefinitionModel` as a JSON string.
`ActionDefinitionQuery`	`createActionDefinitionQuery()`	Query case definitions
`ActionDeploymentBuilder`	`createDeployment()`	Starts creating a new deployment
`ActionDeploymentQuery`	`createDeploymentQuery()`	Query deployments
`void`	`deleteActionDefinitionLink(java.lang.String actionDefinitionLinkId)`	Deletes an `ActionDefinitionLink` for the given action definition link id.
`void`	`deleteDeployment(java.lang.String deploymentId)`	Deletes the given deployment.
`ActionDefinition`	`getActionDefinition(java.lang.String actionDefinitionId)`	Returns the `ActionDefinition` including all action information like additional Properties (e.g.
`ActionDefinition`	`getActionDefinitionByKey(java.lang.String actionDefinitionKey)`	Returns the `ActionDefinition` including all action information like additional Properties (e.g.
`ActionDefinition`	`getActionDefinitionByKeyAndTenantId(java.lang.String actionDefinitionKey, java.lang.String tenantId)`	Returns the `ActionDefinition` including all action information like additional Properties (e.g.
`java.util.List<ActionDefinitionLink>`	`getActionDefinitionLinks(java.lang.String actionDefinitionId)`	Returns `ActionDefinitionLink`s for the given action definition id.
`ActionDefinitionModel`	`getActionDefinitionModel(java.lang.String actionDefinitionId)`	Returns the `ActionDefinitionModel` including all action model info.
`ActionDefinitionModel`	`getActionDefinitionModelByKey(java.lang.String actionDefinitionKey)`	Returns the `ActionDefinitionModel` including all action model info, using the action definition key and resolving the key to the latest version.
`ActionDefinitionModel`	`getActionDefinitionModelByKeyAndTenantId(java.lang.String actionDefinitionKey, java.lang.String tenantId)`	Returns the `ActionDefinitionModel` including all action model info, using the action definition key and resolving the key to the latest version.
`java.util.List<java.lang.String>`	`getDeploymentResourceNames(java.lang.String deploymentId)`	Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
`java.io.InputStream`	`getResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)`	Gives access to a deployment resource through a stream of bytes.

Method Details
- createDeployment
  
  ActionDeploymentBuilder createDeployment()
  
  Starts creating a new deployment
- getDeploymentResourceNames
  
  java.util.List<java.lang.String> getDeploymentResourceNames(java.lang.String deploymentId)
  
  Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
  
  Parameters:
  
  deploymentId - id of the deployment, cannot be null.
- getResourceAsStream
  
  java.io.InputStream getResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)
  
  Gives access to a deployment resource through a stream of bytes.
  
  Parameters:
  
  deploymentId - id of the deployment, cannot be null.
  
  resourceName - name of the resource, cannot be null.
  
  Throws:
  
  org.flowable.common.engine.api.FlowableObjectNotFoundException - when the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.
- getActionDefinitionModel
  
  ActionDefinitionModel getActionDefinitionModel(java.lang.String actionDefinitionId)
  
  Returns the ActionDefinitionModel including all action model info.
- getActionDefinitionModelByKey
  
  ActionDefinitionModel getActionDefinitionModelByKey(java.lang.String actionDefinitionKey)
  
  Returns the ActionDefinitionModel including all action model info, using the action definition key and resolving the key to the latest version.
- getActionDefinitionModelByKeyAndTenantId
  
  ActionDefinitionModel getActionDefinitionModelByKeyAndTenantId(java.lang.String actionDefinitionKey, java.lang.String tenantId)
  
  Returns the ActionDefinitionModel including all action model info, using the action definition key and resolving the key to the latest version.
- convertActionDefinitionModelToJson
  
  java.lang.String convertActionDefinitionModelToJson(java.lang.String actionDefinitionId)
  
  Returns the ActionDefinitionModel as a JSON string.
- getActionDefinition
  
  ActionDefinition getActionDefinition(java.lang.String actionDefinitionId)
  
  Returns the ActionDefinition including all action information like additional Properties (e.g. documentation).
- getActionDefinitionByKey
  
  ActionDefinition getActionDefinitionByKey(java.lang.String actionDefinitionKey)
  
  Returns the ActionDefinition including all action information like additional Properties (e.g. documentation). The latest version for the given key will be returned.
- getActionDefinitionByKeyAndTenantId
  
  ActionDefinition getActionDefinitionByKeyAndTenantId(java.lang.String actionDefinitionKey, java.lang.String tenantId)
  
  Returns the ActionDefinition including all action information like additional Properties (e.g. documentation). The latest version for the given key will be returned.
- getActionDefinitionLinks
  
  java.util.List<ActionDefinitionLink> getActionDefinitionLinks(java.lang.String actionDefinitionId)
  
  Returns ActionDefinitionLinks for the given action definition id.
- addActionDefinitionLink
  
  ActionDefinitionLink addActionDefinitionLink(java.lang.String actionDefinitionId, java.lang.String type, java.lang.String linkValue)
  
  Adds a new ActionDefinitionLink for the given action definition id.
- deleteActionDefinitionLink
  
  void deleteActionDefinitionLink(java.lang.String actionDefinitionLinkId)
  
  Deletes an ActionDefinitionLink for the given action definition link id.
- deleteDeployment
  
  void deleteDeployment(java.lang.String deploymentId)
  
  Deletes the given deployment.
  
  Parameters:
  
  deploymentId - id of the deployment, cannot be null.
- createDeploymentQuery
  
  ActionDeploymentQuery createDeploymentQuery()
  
  Query deployments
- createActionDefinitionQuery
  
  ActionDefinitionQuery createActionDefinitionQuery()
  
  Query case definitions

Interface ActionRepositoryService

Method Summary

Method Details