com.flowable.template.api

Interface TemplateEngineConfigurationApi

All Known Implementing Classes:

TemplateEngineConfiguration

public interface TemplateEngineConfigurationApi

The template engine configuration where you can access the different services.

Author:

Tijs Rademakers, Micha Kiener

Method Summary

Modifier and Type	Method and Description
List<TemplateProcessor>	getTemplateProcessors() Returns the currently registered template processors.
TemplateRepositoryService	getTemplateRepositoryService() Returns the template repository service to query for template definitions or to create template definition deployments.
TemplateService	getTemplateService() Returns the template service used to render templates based on a template definition.
void	registerTemplateProcessor(TemplateProcessor templateProcessor) Registers the given template processor for processing template content.
void	removeTemplateProcessor(TemplateProcessor templateProcessor) Removes a previously registered template processor.
void	setTemplateProcessors(List<TemplateProcessor> processors) If you need / want to overwrite the full list of processors, use this method to provide a list of processors (they are consumed in exactly the given order in the list).

Method Detail

getTemplateRepositoryService

TemplateRepositoryService getTemplateRepositoryService()

Returns the template repository service to query for template definitions or to create template definition deployments.

getTemplateService

TemplateService getTemplateService()

Returns the template service used to render templates based on a template definition.

registerTemplateProcessor

void registerTemplateProcessor(TemplateProcessor templateProcessor)

Registers the given template processor for processing template content. They will be asked for supporting templates in exactly the same order as they have been registered.

Parameters:

templateProcessor - the template processor to register

removeTemplateProcessor

void removeTemplateProcessor(TemplateProcessor templateProcessor)

Removes a previously registered template processor.

Parameters:

templateProcessor - the processor to be removed

setTemplateProcessors

void setTemplateProcessors(List<TemplateProcessor> processors)

If you need / want to overwrite the full list of processors, use this method to provide a list of processors (they are consumed in exactly the given order in the list).

Parameters:

processors - the processors to register

getTemplateProcessors

List<TemplateProcessor> getTemplateProcessors()

Returns the currently registered template processors.