Package com.flowable.template.api.runtime

Interface TemplateProcessingBuilder

All Known Implementing Classes:
TemplateProcessingBuilderImpl
public interface TemplateProcessingBuilder

  • Method Details

    • templateKey

      TemplateProcessingBuilder templateKey(String templateKey)
      The key of the template to process.

    • variableContainer

      TemplateProcessingBuilder variableContainer(VariableContainer variableContainer)
      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.

    • variableContainerSameDeployment

      TemplateProcessingBuilder variableContainerSameDeployment(boolean sameDeployment)
      Whether the template model for processing should be looked within the same deployment of the variableContainer. Has impact only if variableContainer has been set.

    • variant

      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)

    • payload

      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)

    • parentDeploymentId

      TemplateProcessingBuilder parentDeploymentId(String parentDeploymentId)
      Restricts the lookup of the TemplateDefinition using the 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.

    • tenantId

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

    • disableContentItemCreation

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

    • process

      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. The payload is used for the placeholders within the template content and must be valid according the TemplateVariationModel.getParameters() definition.