All Known Implementing Classes:: TemplateRepositoryServiceImpl

public interface TemplateRepositoryService

Method Summary

Modifier and Type	Method	Description
`TemplateDeploymentBuilder`	`createDeployment()`	Starts creating a new deployment
`TemplateDeploymentQuery`	`createDeploymentQuery()`	Query deployments
`TemplateDefinitionQuery`	`createTemplateDefinitionQuery()`	Query template definitions
`TemplateVariationDefinitionQuery`	`createTemplateVariationDefinitionQuery()`	Query template variation 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.
`java.io.InputStream`	`getResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)`	Gives access to a deployment resource through a stream of bytes.
`TemplateModel`	`getTemplateDefinitionModelByKey(java.lang.String templateDefinitionKey)`	Returns the `TemplateModel` including all template model info.
`TemplateModel`	`getTemplateDefinitionModelByKeyAndTenantId(java.lang.String templateDefinitionKey, java.lang.String tenantId)`	Returns the `TemplateModel` including all template model info.
`java.lang.String`	`getTemplateDefinitionModelToJson(java.lang.String templateDefinitionKey)`	Returns the `TemplateModel` as a JSON string.
`TemplateVariationModel`	`getTemplateVariationDefinitionModel(java.lang.String templateVariationDefinitionId)`	Returns the `TemplateVariationModel` including all template model info.
`java.lang.String`	`getTemplateVariationDefinitionModelToJson(java.lang.String templateVariationDefinitionId)`	Returns the `TemplateVariationModel` as a JSON string.

Method Details
- createDeployment
  
  TemplateDeploymentBuilder 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.
- getTemplateDefinitionModelByKey
  
  TemplateModel getTemplateDefinitionModelByKey(java.lang.String templateDefinitionKey)
  
  Returns the TemplateModel including all template model info.
- getTemplateDefinitionModelByKeyAndTenantId
  
  TemplateModel getTemplateDefinitionModelByKeyAndTenantId(java.lang.String templateDefinitionKey, java.lang.String tenantId)
  
  Returns the TemplateModel including all template model info.
- getTemplateDefinitionModelToJson
  
  java.lang.String getTemplateDefinitionModelToJson(java.lang.String templateDefinitionKey)
  
  Returns the TemplateModel as a JSON string.
- getTemplateVariationDefinitionModel
  
  TemplateVariationModel getTemplateVariationDefinitionModel(java.lang.String templateVariationDefinitionId)
  
  Returns the TemplateVariationModel including all template model info.
- getTemplateVariationDefinitionModelToJson
  
  java.lang.String getTemplateVariationDefinitionModelToJson(java.lang.String templateVariationDefinitionId)
  
  Returns the TemplateVariationModel as a JSON string.
- deleteDeployment
  
  void deleteDeployment(java.lang.String deploymentId)
  
  Deletes the given deployment.
  
  Parameters:
  
  deploymentId - id of the deployment, cannot be null.
- createDeploymentQuery
  
  TemplateDeploymentQuery createDeploymentQuery()
  
  Query deployments
- createTemplateDefinitionQuery
  
  TemplateDefinitionQuery createTemplateDefinitionQuery()
  
  Query template definitions
- createTemplateVariationDefinitionQuery
  
  TemplateVariationDefinitionQuery createTemplateVariationDefinitionQuery()
  
  Query template variation definitions

Interface TemplateRepositoryService

Method Summary

Method Details