Package com.flowable.template.engine.impl.runtime

Class TemplateProcessingBuilderImpl

java.lang.Object

com.flowable.template.engine.impl.runtime.TemplateProcessingBuilderImpl

All Implemented Interfaces:

TemplateProcessingBuilder

public class TemplateProcessingBuilderImpl
extends Object
implements TemplateProcessingBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	disableContentItemCreation
protected String	parentDeploymentId
protected Map<String,Object>	payload
protected boolean	strictProcessingMode
protected String	templateKey
protected TemplateServiceImpl	templateService
protected String	tenantId
protected VariableContainer	variableContainer
protected boolean	variableContainerSameDeployment
protected Map<String,Object>	variant

Constructor Summary

Constructors

Constructor	Description
TemplateProcessingBuilderImpl(TemplateServiceImpl templateService)

Method Summary

Modifier and Type	Method	Description
TemplateProcessingBuilder	disableContentItemCreation()	By default a ContentItem is created for types that support it.
String	getParentDeploymentId()
Map<String,Object>	getPayload()
String	getTemplateKey()
TemplateServiceImpl	getTemplateService()
String	getTenantId()
VariableContainer	getVariableContainer()
Map<String,Object>	getVariant()
boolean	isDisableContentItemCreation()
boolean	isStrictProcessingMode()
boolean	isVariableContainerSameDeployment()
TemplateProcessingBuilder	parentDeploymentId(String parentDeploymentId)	Restricts the lookup of the TemplateDefinition using the TemplateProcessingBuilder.templateKey(String) to the given parent deployment.
TemplateProcessingBuilder	payload(Map<String,Object> payload)	the optional payload, if the template is using placeholders to render properly (must be valid according the parameter definition)
TemplateProcessingResult	process()	Processes a template referenced through its key and variant data (if set) which is then looked up within the repository and represented by a TemplateVariationModel.
void	setDisableContentItemCreation(boolean disableContentItemCreation)
void	setParentDeploymentId(String parentDeploymentId)
void	setPayload(Map<String,Object> payload)
void	setStrictProcessingMode(boolean strictProcessingMode)
void	setTemplateKey(String templateKey)
void	setTemplateService(TemplateServiceImpl templateService)
void	setTenantId(String tenantId)
void	setVariableContainer(VariableContainer variableContainer)
void	setVariant(Map<String,Object> variant)
TemplateProcessingBuilder	strictProcessingMode()	Processes the template strictly: if an error happens (e.g.
TemplateProcessingBuilder	templateKey(String templateKey)	The key of the template to process.
TemplateProcessingBuilder	tenantId(String tenantId)	The tenantId for looking up the template definition.
TemplateProcessingBuilder	variableContainer(VariableContainer variableContainer)	An instance that has variables such as a task, process or case instance.
TemplateProcessingBuilder	variableContainerSameDeployment(boolean sameDeployment)	Whether the template model for processing should be looked within the same deployment of the variableContainer.
TemplateProcessingBuilder	variant(Map<String,Object> 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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

templateService

protected TemplateServiceImpl templateService

templateKey

protected String templateKey

variableContainer

protected VariableContainer variableContainer

variableContainerSameDeployment

protected boolean variableContainerSameDeployment

variant

protected Map<String,Object> variant

payload

protected Map<String,Object> payload

disableContentItemCreation

protected boolean disableContentItemCreation

strictProcessingMode

protected boolean strictProcessingMode

parentDeploymentId

protected String parentDeploymentId

tenantId

protected String tenantId

Constructor Details

TemplateProcessingBuilderImpl

public TemplateProcessingBuilderImpl(TemplateServiceImpl templateService)

Method Details

templateKey

public TemplateProcessingBuilder templateKey(String templateKey)

Description copied from interface: TemplateProcessingBuilder

The key of the template to process.

Specified by:

templateKey in interface TemplateProcessingBuilder

variableContainer

public TemplateProcessingBuilder variableContainer(VariableContainer variableContainer)

Description copied from interface: TemplateProcessingBuilder

An instance that has variables such as a task, process or case instance. When no variant variables were set and a variable container is passed, the model is inspected to retrieve the variant variables from it. If the variant variables are set explicitely, these variables are ignored.

Specified by:

variableContainer in interface TemplateProcessingBuilder

variableContainerSameDeployment

public TemplateProcessingBuilder variableContainerSameDeployment(boolean sameDeployment)

Description copied from interface: TemplateProcessingBuilder

Whether the template model for processing should be looked within the same deployment of the variableContainer. Has impact only if variableContainer has been set.

Specified by:

variableContainerSameDeployment in interface TemplateProcessingBuilder

variant

public TemplateProcessingBuilder variant(Map<String,Object> variant)

Description copied from interface: TemplateProcessingBuilder

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)

Specified by:

variant in interface TemplateProcessingBuilder

payload

public TemplateProcessingBuilder payload(Map<String,Object> payload)

Description copied from interface: TemplateProcessingBuilder

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

Specified by:

payload in interface TemplateProcessingBuilder

parentDeploymentId

public TemplateProcessingBuilder parentDeploymentId(String parentDeploymentId)

Description copied from interface: TemplateProcessingBuilder

Restricts the lookup of the TemplateDefinition using the TemplateProcessingBuilder.templateKey(String) to the given parent deployment. This is typically needed when the template service is called for example from the process or case engine to generate a document and it needs to look up the template definition in the same deployment.

Specified by:

parentDeploymentId in interface TemplateProcessingBuilder

tenantId

public TemplateProcessingBuilder tenantId(String tenantId)

Description copied from interface: TemplateProcessingBuilder

The tenantId for looking up the template definition. If a TemplateProcessingBuilder.variableContainer(VariableContainer) is set, the tenant id will be taken from there, unless a tenantId was explicitely set with this method.

Specified by:

tenantId in interface TemplateProcessingBuilder

disableContentItemCreation

public TemplateProcessingBuilder disableContentItemCreation()

Description copied from interface: TemplateProcessingBuilder

By default a ContentItem is created for types that support it. Calling this method will disable the creation of that conten item.

Specified by:

disableContentItemCreation in interface TemplateProcessingBuilder

strictProcessingMode

public TemplateProcessingBuilder strictProcessingMode()

Description copied from interface: TemplateProcessingBuilder

Processes the template strictly: if an error happens (e.g. missing a required variable), an exception will be thrown. The default is non-strict, which means that a processed template will be returned, potentially incomplete or with errors inside it.

Specified by:

strictProcessingMode in interface TemplateProcessingBuilder

process

public TemplateProcessingResult process()

Description copied from interface: TemplateProcessingBuilder

Processes a template referenced through its key and variant data (if set) 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.

Specified by:

process in interface TemplateProcessingBuilder

getTemplateService

public TemplateServiceImpl getTemplateService()

setTemplateService

public void setTemplateService(TemplateServiceImpl templateService)

getTemplateKey

public String getTemplateKey()

setTemplateKey

public void setTemplateKey(String templateKey)

getVariableContainer

public VariableContainer getVariableContainer()

setVariableContainer

public void setVariableContainer(VariableContainer variableContainer)

isVariableContainerSameDeployment

public boolean isVariableContainerSameDeployment()

getVariant

public Map<String,Object> getVariant()

setVariant

public void setVariant(Map<String,Object> variant)

getPayload

public Map<String,Object> getPayload()

setPayload

public void setPayload(Map<String,Object> payload)

isDisableContentItemCreation

public boolean isDisableContentItemCreation()

setDisableContentItemCreation

public void setDisableContentItemCreation(boolean disableContentItemCreation)

isStrictProcessingMode

public boolean isStrictProcessingMode()

setStrictProcessingMode

public void setStrictProcessingMode(boolean strictProcessingMode)

getParentDeploymentId

public String getParentDeploymentId()

setParentDeploymentId

public void setParentDeploymentId(String parentDeploymentId)

getTenantId

public String getTenantId()

setTenantId

public void setTenantId(String tenantId)