Package com.flowable.template.api.repository

Interface TemplateVariationDefinition

All Superinterfaces:
org.flowable.common.engine.api.repository.FlowableDefinition
All Known Subinterfaces:
TemplateVariationDefinitionEntity
All Known Implementing Classes:
TemplateVariationDefinitionEntityImpl
public interface TemplateVariationDefinition extends org.flowable.common.engine.api.repository.FlowableDefinition
This template variation definition holds one single variation of a TemplateDefinition for one combination of variants like language, country, etc. The variation key returned with getVariationKey() returns a composed value of all variations as a single value.
Author:
Micha Kiener

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getContentId()
    Returns the optional id of the referenced content to retrieve the template variation content with the content engine.
    String
    getExternalId()
    Returns the optional external id this template variation is linked with (e.g. the id of a template message in WeChat or an externally referenced document template in a ECM system).
    default String
    getKey()
    The key of a template variation definition is its variation key.
    String
    getTemplateDefinitionKey()
    Returns the referenced business key of the TemplateDefinition this variation is based on.
    Date
    getValidFrom()
    Returns the timestamp from which this template variation is valid, must not be null, use new Date(0L) instead if the variation definition should be valid back in time.
    Date
    getValidTo()
    Returns the timestamp until which this template variation is valid, must not be null, use new Date(Long.MAX_VALUE) instead if the variation definition should be valid forever.
    String
    getVariationKey()
    Returns the single, composed variation key created out of all variation values this template is used for (e.g.
    boolean
    hasSmallContent()
    Returns true, if this template only has small content (e.g. a message or email template), false, if the content needs to be retrieved with the content engine.

    Methods inherited from interface org.flowable.common.engine.api.repository.FlowableDefinition

    getDeploymentId, getId, getName, getResourceName, getTenantId, getVersion

  • Method Details

    • getTemplateDefinitionKey

      String getTemplateDefinitionKey()
      Returns the referenced business key of the TemplateDefinition this variation is based on.

    • getValidFrom

      Date getValidFrom()
      Returns the timestamp from which this template variation is valid, must not be null, use new Date(0L) instead if the variation definition should be valid back in time.

    • getValidTo

      Date getValidTo()
      Returns the timestamp until which this template variation is valid, must not be null, use new Date(Long.MAX_VALUE) instead if the variation definition should be valid forever.

    • getExternalId

      String getExternalId()
      Returns the optional external id this template variation is linked with (e.g. the id of a template message in WeChat or an externally referenced document template in a ECM system).

    • getVariationKey

      String getVariationKey()
      Returns the single, composed variation key created out of all variation values this template is used for (e.g. 'che_de' or 'mobile_de', etc).

    • getKey

      default String getKey()
      The key of a template variation definition is its variation key.
      Specified by:
      getKey in interface org.flowable.common.engine.api.repository.FlowableDefinition
      Returns:
      the variation key, see getVariationKey()

    • hasSmallContent

      boolean hasSmallContent()
      Returns true, if this template only has small content (e.g. a message or email template), false, if the content needs to be retrieved with the content engine.

    • getContentId

      String getContentId()
      Returns the optional id of the referenced content to retrieve the template variation content with the content engine. If this template variation only contains small content (hasSmallContent() returning true), the content id is null.