Package com.flowable.core.content.api

Interface DocumentRepositoryService

All Known Implementing Classes:
DocumentRepositoryServiceImpl
public interface DocumentRepositoryService

  • Method Details

    • createDeployment

      DocumentDeploymentBuilder 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.

    • getDocumentDefinitionModel

      DocumentDefinitionModel getDocumentDefinitionModel(String documentDefinitionId)
      Returns the DocumentDefinitionModel including all action model info.

    • convertDocumentDefinitionModelToJson

      String convertDocumentDefinitionModelToJson(String documentDefinitionId)
      Returns the DocumentDefinitionModel as a JSON string.

    • getDocumentDefinition

      DocumentDefinition getDocumentDefinition(String documentDefinitionId)
      Returns the DocumentDefinition including all action information like additional Properties (e.g. documentation).

    • getDocumentDefinitionByKey

      DocumentDefinition getDocumentDefinitionByKey(String documentDefinitionKey)
      Returns the latest DocumentDefinition for the given key.

    • getDocumentDefinitionByKeyAndTenantId

      DocumentDefinition getDocumentDefinitionByKeyAndTenantId(String documentDefinitionKey, String tenantId)
      Returns the latest DocumentDefinition for the given key in the given tenant.

    • setDocumentDefinitionCategory

      void setDocumentDefinitionCategory(String documentDefinitionId, String category)

    • deleteDeployment

      void deleteDeployment(String deploymentId)
      Deletes the given deployment.
      Parameters:
      deploymentId - id of the deployment, cannot be null.

    • createDeploymentQuery

      DocumentDeploymentQuery createDeploymentQuery()
      Query deployments

    • createDocumentDefinitionQuery

      DocumentDefinitionQuery createDocumentDefinitionQuery()
      Query case definitions