Package com.flowable.template.api.repository

Interface TemplateVariationDefinition

All Known Subinterfaces:
TemplateVariationDefinitionEntity
All Known Implementing Classes:
TemplateVariationDefinitionEntityImpl
public interface TemplateVariationDefinition
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
    java.lang.String getContentId()
    Returns the optional id of the referenced content to retrieve the template variation content with the content engine.
    java.lang.String getDeploymentId()
    Returns the deployment id this definition variation was deployed with.
    java.lang.String getExternalId()
    Returns the optional external id this template variation is linked with (e.g.
    java.lang.String getId()
    Returns the unique id of this template variation definition.
    java.lang.String getName()
    Returns the name of this template variation definition.
    java.lang.String getResourceName()
    Returns the optional resource name of the persisted template.
    java.lang.String getTemplateDefinitionKey()
    Returns the referenced business key of the TemplateDefinition this variation is based on.
    java.lang.String getTenantId()
    Returns the id of the tenant this definition variation belongs to.
    java.util.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.
    java.util.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.
    java.lang.String getVariationKey()
    Returns the single, composed variation key created out of all variation values this template is used for (e.g.
    int getVersion()
    Returns the version of this template variation definition (increases upon a new deployment).
    boolean hasSmallContent()
    Returns true, if this template only has small content (e.g.

  • Method Details

    • getId

      java.lang.String getId()
      Returns the unique id of this template variation definition.

    • getTemplateDefinitionKey

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

    • getVersion

      int getVersion()
      Returns the version of this template variation definition (increases upon a new deployment).

    • getValidFrom

      java.util.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

      java.util.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.

    • getDeploymentId

      java.lang.String getDeploymentId()
      Returns the deployment id this definition variation was deployed with.

    • getTenantId

      java.lang.String getTenantId()
      Returns the id of the tenant this definition variation belongs to.

    • getExternalId

      java.lang.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

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

    • getName

      java.lang.String getName()
      Returns the name of this template variation definition.

    • 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

      java.lang.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.

    • getResourceName

      java.lang.String getResourceName()
      Returns the optional resource name of the persisted template.