Package com.flowable.core.content.api

Interface DocumentRepositoryService

    • Method Detail

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

      • convertDocumentDefinitionModelToJson

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

      • getDocumentDefinition

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

      • getDocumentDefinitionByKeyAndTenantId

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

      • setDocumentDefinitionCategory

        void setDocumentDefinitionCategory​(java.lang.String documentDefinitionId,
                                   java.lang.String category)

      • deleteDeployment

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