Package com.flowable.action.api.repository

Interface ActionRepositoryService

All Known Implementing Classes:
ActionRepositoryServiceImpl
public interface ActionRepositoryService

  • Method Details

    • createDeployment

      ActionDeploymentBuilder createDeployment()
      Starts creating a new deployment

    • getDeploymentResourceNames

      List<String> getDeploymentResourceNames(String deploymentId)
      Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
      Parameters:
      deploymentId - id of the deployment, cannot be null.

    • getResourceAsStream

      InputStream getResourceAsStream(String deploymentId, 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:
      FlowableObjectNotFoundException - when the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.

    • getActionDefinitionModel

      ActionDefinitionModel getActionDefinitionModel(String actionDefinitionId)
      Returns the ActionDefinitionModel including all action model info.

    • getActionDefinitionModelByKey

      ActionDefinitionModel getActionDefinitionModelByKey(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(String actionDefinitionKey, String tenantId)
      Returns the ActionDefinitionModel including all action model info, using the action definition key and resolving the key to the latest version.

    • convertActionDefinitionModelToJson

      String convertActionDefinitionModelToJson(String actionDefinitionId)
      Returns the ActionDefinitionModel as a JSON string.

    • getActionDefinition

      ActionDefinition getActionDefinition(String actionDefinitionId)
      Returns the ActionDefinition including all action information like additional Properties (e.g. documentation).

    • getActionDefinitionByKey

      ActionDefinition getActionDefinitionByKey(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(String actionDefinitionKey, 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

      List<ActionDefinitionLink> getActionDefinitionLinks(String actionDefinitionId)
      Returns ActionDefinitionLinks for the given action definition id.

    • addActionDefinitionLink

      ActionDefinitionLink addActionDefinitionLink(String actionDefinitionId, String type, String linkValue)
      Adds a new ActionDefinitionLink for the given action definition id.

    • deleteActionDefinitionLink

      void deleteActionDefinitionLink(String actionDefinitionLinkId)
      Deletes an ActionDefinitionLink for the given action definition link id.

    • deleteDeployment

      void deleteDeployment(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