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 java.lang.Object
implements TemplateProcessingBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	disableContentItemCreation
protected java.lang.String	parentDeploymentId
protected java.util.Map<java.lang.String,java.lang.Object>	payload
protected java.lang.String	templateKey
protected TemplateServiceImpl	templateService
protected java.lang.String	tenantId
protected org.flowable.common.engine.api.variable.VariableContainer	variableContainer
protected boolean	variableContainerSameDeployment
protected java.util.Map<java.lang.String,java.lang.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.
java.lang.String	getParentDeploymentId()
java.util.Map<java.lang.String,java.lang.Object>	getPayload()
java.lang.String	getTemplateKey()
TemplateServiceImpl	getTemplateService()
java.lang.String	getTenantId()
org.flowable.common.engine.api.variable.VariableContainer	getVariableContainer()
java.util.Map<java.lang.String,java.lang.Object>	getVariant()
boolean	isDisableContentItemCreation()
boolean	isVariableContainerSameDeployment()
TemplateProcessingBuilder	parentDeploymentId(java.lang.String parentDeploymentId)	Restricts the lookup of the TemplateDefinition using the TemplateProcessingBuilder.templateKey(String) to the given parent deployment.
TemplateProcessingBuilder	payload(java.util.Map<java.lang.String,java.lang.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(java.lang.String parentDeploymentId)
void	setPayload(java.util.Map<java.lang.String,java.lang.Object> payload)
void	setTemplateKey(java.lang.String templateKey)
void	setTemplateService(TemplateServiceImpl templateService)
void	setTenantId(java.lang.String tenantId)
void	setVariableContainer(org.flowable.common.engine.api.variable.VariableContainer variableContainer)
void	setVariant(java.util.Map<java.lang.String,java.lang.Object> variant)
TemplateProcessingBuilder	templateKey(java.lang.String templateKey)	The key of the template to process.
TemplateProcessingBuilder	tenantId(java.lang.String tenantId)	The tenantId for looking up the template definition.
TemplateProcessingBuilder	variableContainer(org.flowable.common.engine.api.variable.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(java.util.Map<java.lang.String,java.lang.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 java.lang.String templateKey

variableContainer

protected org.flowable.common.engine.api.variable.VariableContainer variableContainer

variableContainerSameDeployment

protected boolean variableContainerSameDeployment

variant

protected java.util.Map<java.lang.String,java.lang.Object> variant

payload

protected java.util.Map<java.lang.String,java.lang.Object> payload

disableContentItemCreation

protected boolean disableContentItemCreation

parentDeploymentId

protected java.lang.String parentDeploymentId

tenantId

protected java.lang.String tenantId

Constructor Details

TemplateProcessingBuilderImpl

public TemplateProcessingBuilderImpl(TemplateServiceImpl templateService)

Method Details

templateKey

public TemplateProcessingBuilder templateKey(java.lang.String templateKey)

Description copied from interface: TemplateProcessingBuilder

The key of the template to process.

Specified by:

templateKey in interface TemplateProcessingBuilder

variableContainer

public TemplateProcessingBuilder variableContainer(org.flowable.common.engine.api.variable.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.lang.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(java.lang.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

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 java.lang.String getTemplateKey()

setTemplateKey

public void setTemplateKey(java.lang.String templateKey)

getVariableContainer

public org.flowable.common.engine.api.variable.VariableContainer getVariableContainer()

setVariableContainer

public void setVariableContainer(org.flowable.common.engine.api.variable.VariableContainer variableContainer)

isVariableContainerSameDeployment

public boolean isVariableContainerSameDeployment()

getVariant

public java.util.Map<java.lang.String,java.lang.Object> getVariant()

setVariant

public void setVariant(java.util.Map<java.lang.String,java.lang.Object> variant)

getPayload

public java.util.Map<java.lang.String,java.lang.Object> getPayload()

setPayload

public void setPayload(java.util.Map<java.lang.String,java.lang.Object> payload)

isDisableContentItemCreation

public boolean isDisableContentItemCreation()

setDisableContentItemCreation

public void setDisableContentItemCreation(boolean disableContentItemCreation)

getParentDeploymentId

public java.lang.String getParentDeploymentId()

setParentDeploymentId

public void setParentDeploymentId(java.lang.String parentDeploymentId)

getTenantId

public java.lang.String getTenantId()

setTenantId

public void setTenantId(java.lang.String tenantId)