Package com.flowable.template.api.repository

Class BaseTemplateModel

java.lang.Object
com.flowable.template.api.repository.BaseTemplateModel
All Implemented Interfaces:
TemplateModel
public class BaseTemplateModel
extends java.lang.Object
implements TemplateModel

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected java.lang.String description  
    protected java.lang.String formKey  
    protected java.lang.String key  
    protected java.lang.String name  
    protected java.lang.String subType  
    protected java.lang.String type  
    protected java.lang.String variationContentType  
    protected java.util.List<VariationDefinition> variationDefinitions  
    protected java.lang.String versionTimestamp  

  • Constructor Summary

    Constructors 
    Constructor Description
    BaseTemplateModel()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDescription()
    Returns the optional description of this template definition, describing where and how it might be used.
    java.lang.String getFormKey()
    Returns the optional form key for this template definition which might be used to collect information whenever such a template instance is created.
    java.lang.String getKey()
    Returns the business key usually used to reference or lookup a template definition regardless of its version.
    java.lang.String getName()
    Returns the name of this template definition.
    java.lang.String getSubType()
    Returns the sub type of this template definition which can be freely chosen.
    java.lang.String getType()
    Returns the type of this template definition which is used to lookup a renderer or processor being able to render and process this template.
    java.lang.String getVariationContentType()
    The type of the variation content.
    java.util.List<VariationDefinition> getVariationDefinitions()
    Returns the optional list of variations this template needs to lookup the correct TemplateVariationDefinition to be used when rendering a single template for a certain variation.
    java.lang.String getVersionTimestamp()
    Returns the version timestamp for this template definition that is used to check if a new template needs to be deployed.
    boolean hasVariations()
    Returns true if this template definition has variations or just has a single variation.
    void setDescription​(java.lang.String description)  
    void setFormKey​(java.lang.String formKey)  
    void setKey​(java.lang.String key)  
    void setName​(java.lang.String name)  
    void setSubType​(java.lang.String subType)  
    void setType​(java.lang.String type)  
    void setVariationContentType​(java.lang.String variationContentType)  
    void setVariationDefinitions​(java.util.List<VariationDefinition> variationDefinitions)  
    void setVersionTimestamp​(java.lang.String versionTimestamp)  

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • getKey

      public java.lang.String getKey()
      Description copied from interface: TemplateModel
      Returns the business key usually used to reference or lookup a template definition regardless of its version.
      Specified by:
      getKey in interface TemplateModel

    • setKey

      public void setKey​(java.lang.String key)

    • getName

      public java.lang.String getName()
      Description copied from interface: TemplateModel
      Returns the name of this template definition.
      Specified by:
      getName in interface TemplateModel

    • setName

      public void setName​(java.lang.String name)

    • getDescription

      public java.lang.String getDescription()
      Description copied from interface: TemplateModel
      Returns the optional description of this template definition, describing where and how it might be used.
      Specified by:
      getDescription in interface TemplateModel

    • setDescription

      public void setDescription​(java.lang.String description)

    • getType

      public java.lang.String getType()
      Description copied from interface: TemplateModel
      Returns the type of this template definition which is used to lookup a renderer or processor being able to render and process this template.
      Specified by:
      getType in interface TemplateModel
      See Also:
      for a set of predefined template types

    • setType

      public void setType​(java.lang.String type)

    • getSubType

      public java.lang.String getSubType()
      Description copied from interface: TemplateModel
      Returns the sub type of this template definition which can be freely chosen.
      Specified by:
      getSubType in interface TemplateModel

    • setSubType

      public void setSubType​(java.lang.String subType)

    • getVariationContentType

      public java.lang.String getVariationContentType()
      Description copied from interface: TemplateModel
      The type of the variation content. This is used by the TemplateProcessor(s) to decide whether they can render certain template or not.
      Specified by:
      getVariationContentType in interface TemplateModel
      Returns:
      the type of the variation content

    • setVariationContentType

      public void setVariationContentType​(java.lang.String variationContentType)

    • getFormKey

      public java.lang.String getFormKey()
      Description copied from interface: TemplateModel
      Returns the optional form key for this template definition which might be used to collect information whenever such a template instance is created. For instance, this form might ask for necessary categorization information when creating a new document based on a template or request parameter values if a message template should be rendered, etc.
      Specified by:
      getFormKey in interface TemplateModel

    • setFormKey

      public void setFormKey​(java.lang.String formKey)

    • getVersionTimestamp

      public java.lang.String getVersionTimestamp()
      Description copied from interface: TemplateModel
      Returns the version timestamp for this template definition that is used to check if a new template needs to be deployed. The timestamp should have a format of 'yyyy-MM-dd' (2018-02-01) or 'yyyy-MM-dd HH:mm:ss' (2018-02-01 14:00:00)
      Specified by:
      getVersionTimestamp in interface TemplateModel

    • setVersionTimestamp

      public void setVersionTimestamp​(java.lang.String versionTimestamp)

    • hasVariations

      public boolean hasVariations()
      Description copied from interface: TemplateModel
      Returns true if this template definition has variations or just has a single variation. If true is returned, the method TemplateModel.getVariationDefinitions() needs to return at least one variation definition, otherwise it must return an empty list or even null.
      Specified by:
      hasVariations in interface TemplateModel
      Returns:
      true if this template has variations, false if it has one only

    • getVariationDefinitions

      public java.util.List<VariationDefinition> getVariationDefinitions()
      Description copied from interface: TemplateModel
      Returns the optional list of variations this template needs to lookup the correct TemplateVariationDefinition to be used when rendering a single template for a certain variation. If any values are returned, the order must not be random, but exactly defined as it is used to compose the variation key with all variations later on to lookup the variation using TemplateVariationDefinition.getVariationKey().
      Specified by:
      getVariationDefinitions in interface TemplateModel

    • setVariationDefinitions

      public void setVariationDefinitions​(java.util.List<VariationDefinition> variationDefinitions)