All Known Implementing Classes:: DocumentRepositoryServiceImpl

public interface DocumentRepositoryService

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`convertDocumentDefinitionModelToJson(java.lang.String documentDefinitionId)`	Returns the `DocumentDefinitionModel` as a JSON string.
`DocumentDeploymentBuilder`	`createDeployment()`	Starts creating a new deployment
`DocumentDeploymentQuery`	`createDeploymentQuery()`	Query deployments
`DocumentDefinitionQuery`	`createDocumentDefinitionQuery()`	Query case definitions
`void`	`deleteDeployment(java.lang.String deploymentId)`	Deletes the given deployment.
`java.util.List<java.lang.String>`	`getDeploymentResourceNames(java.lang.String deploymentId)`	Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
`DocumentDefinition`	`getDocumentDefinition(java.lang.String documentDefinitionId)`	Returns the `DocumentDefinition` including all action information like additional Properties (e.g.
`DocumentDefinitionModel`	`getDocumentDefinitionModel(java.lang.String documentDefinitionId)`	Returns the `DocumentDefinitionModel` including all action model info.
`java.io.InputStream`	`getResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)`	Gives access to a deployment resource through a stream of bytes.
`void`	`setDocumentDefinitionCategory(java.lang.String documentDefinitionId, java.lang.String category)`

Method Details
- createDeployment
  
  DocumentDeploymentBuilder 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.
- getDocumentDefinitionModel
  
  DocumentDefinitionModel getDocumentDefinitionModel(java.lang.String documentDefinitionId)
  
  Returns the DocumentDefinitionModel including all action model info.
- 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).
- 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.
- createDeploymentQuery
  
  DocumentDeploymentQuery createDeploymentQuery()
  
  Query deployments
- createDocumentDefinitionQuery
  
  DocumentDefinitionQuery createDocumentDefinitionQuery()
  
  Query case definitions

Interface DocumentRepositoryService

Method Summary

Method Details