com.flowable.template.api

Interface TemplateService

All Known Implementing Classes:

TemplateServiceImpl

public interface TemplateService

The template service is used to create and render content based on a TemplateDefinition. The management of template definitions is done through the TemplateRepositoryService.

Author:

Micha Kiener

Method Summary

Modifier and Type	Method and Description
TemplateContentProcessingBuilder	createTemplateContentProcessingBuilder()
TemplateProcessingBuilder	createTemplateProcessingBuilder()
default TemplateProcessingResult	processTemplate(String templateKey, Map<String,Object> variant, Map<String,Object> payload) Processes a template referenced through its key and variant data which is then looked up within the repository and represented by a TemplateVariationModel.
default TemplateProcessingResult	processTemplate(String templateKey, String tenantId, Map<String,Object> variant, Map<String,Object> payload)
default TemplateProcessingResult	processTemplate(String templateKey, VariableContainer variableContainer)

Method Detail

createTemplateProcessingBuilder

TemplateProcessingBuilder createTemplateProcessingBuilder()

createTemplateContentProcessingBuilder

TemplateContentProcessingBuilder createTemplateContentProcessingBuilder()

processTemplate

default TemplateProcessingResult processTemplate(String templateKey,
                                                 Map<String,Object> variant,
                                                 Map<String,Object> payload)

Processes a template referenced through its key and variant data which is then looked up within the repository and represented by a TemplateVariationModel. The payload is used for the placeholders within the template content and must be valid according the TemplateVariationModel.getParameters() definition.

DON'T USE THIS METHOD in a multi-tenant environment, use processTemplate(String, String, Map, Map) instead to provide the tenant-id.

Parameters:

templateKey - the key of the template to process

variant - the variant of the template needed (according the variation definitions TemplateModel.getVariationDefinitions()), might be null or empty if the template only has one single variation)

payload - the optional payload, if the template is using placeholders to render properly (must be valid according the parameter definition)

Returns:

the template processing results

processTemplate

default TemplateProcessingResult processTemplate(String templateKey,
                                                 String tenantId,
                                                 Map<String,Object> variant,
                                                 Map<String,Object> payload)

processTemplate

default TemplateProcessingResult processTemplate(String templateKey,
                                                 VariableContainer variableContainer)