Package com.flowable.template.api.repository

Class BaseTemplateVariationModel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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 getDescription()
      Returns the optional description of this template variation definition, describing where and how it might be used.
      java.lang.String getExternalId()
      Returns the optional external id this template variation is linked with (e.g.
      java.lang.String getKey()
      Returns a composed key for this specific variation of the template definition which is a combination of the template definition key returned by TemplateVariationModel.getTemplateDefinitionKey() and the variation key returned by TemplateVariationModel.getVariationKey().
      java.lang.String getName()
      Returns the optional name for this variation which might be used for template management as it does not have an effect on the template rendering itself.
      java.util.List<TemplateParameter> getParameters()
      Returns an optional list of parameters needed for this template variation in order to create or render it.
      java.lang.String getTemplateDefinitionKey()
      Returns the referenced business key of the TemplateDefinition this variation is based on.
      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 getVariationContent()
      If this variation only contains small content (e.g.
      java.lang.String getVariationContentResource()
      Returns the resource string in case the content is referenced using a Spring Resource.
      java.lang.String getVariationKey()
      Returns the single, composed variation key created out of all variation values this template is used for (e.g.
      java.lang.String getVersionTimestamp()
      Returns the version timestamp for this template variation definition that is used to check if a new template variation needs to be deployed.
      boolean hasVariationContent()
      Returns true, if this template only has small content (e.g.
      boolean isEditable()
      Returns if the template variation is editable at runtime.
      void setContentId​(java.lang.String contentId)  
      void setDescription​(java.lang.String description)  
      void setEditable​(boolean editable)  
      void setExternalId​(java.lang.String externalId)  
      void setName​(java.lang.String name)  
      void setParameters​(java.util.List<TemplateParameter> parameters)  
      void setTemplateDefinitionKey​(java.lang.String templateDefinitionKey)  
      void setValidFrom​(java.util.Date validFrom)  
      void setValidTo​(java.util.Date validTo)  
      void setVariationContent​(java.lang.String variationContent)  
      void setVariationContentResource​(java.lang.String variationContentResource)  
      void setVariationKey​(java.lang.String variationKey)  
      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 Detail

      • templateDefinitionKey

        protected java.lang.String templateDefinitionKey

      • variationKey

        protected java.lang.String variationKey

      • name

        protected java.lang.String name

      • description

        protected java.lang.String description

      • validFrom

        protected java.util.Date validFrom

      • validTo

        protected java.util.Date validTo

      • externalId

        protected java.lang.String externalId

      • variationContent

        protected java.lang.String variationContent

      • variationContentResource

        protected java.lang.String variationContentResource

      • contentId

        protected java.lang.String contentId

      • editable

        protected boolean editable

      • versionTimestamp

        protected java.lang.String versionTimestamp

    • Constructor Detail

      • BaseTemplateVariationModel

        public BaseTemplateVariationModel()

    • Method Detail

      • setTemplateDefinitionKey

        public void setTemplateDefinitionKey​(java.lang.String templateDefinitionKey)

      • getVariationKey

        public java.lang.String getVariationKey()
        Description copied from interface: TemplateVariationModel
        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).
        Specified by:
        getVariationKey in interface TemplateVariationModel

      • setVariationKey

        public void setVariationKey​(java.lang.String variationKey)

      • getName

        public java.lang.String getName()
        Description copied from interface: TemplateVariationModel
        Returns the optional name for this variation which might be used for template management as it does not have an effect on the template rendering itself.
        Specified by:
        getName in interface TemplateVariationModel

      • setName

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

      • getDescription

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

      • setDescription

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

      • getValidFrom

        public java.util.Date getValidFrom()
        Description copied from interface: TemplateVariationModel
        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.
        Specified by:
        getValidFrom in interface TemplateVariationModel

      • setValidFrom

        public void setValidFrom​(java.util.Date validFrom)

      • getValidTo

        public java.util.Date getValidTo()
        Description copied from interface: TemplateVariationModel
        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.
        Specified by:
        getValidTo in interface TemplateVariationModel

      • setValidTo

        public void setValidTo​(java.util.Date validTo)

      • getExternalId

        public java.lang.String getExternalId()
        Description copied from interface: TemplateVariationModel
        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).
        Specified by:
        getExternalId in interface TemplateVariationModel

      • setExternalId

        public void setExternalId​(java.lang.String externalId)

      • getVariationContent

        public java.lang.String getVariationContent()
        Description copied from interface: TemplateVariationModel
        If this variation only contains small content (e.g. a message or email template), the content might be retrievable directly using this method.
        Specified by:
        getVariationContent in interface TemplateVariationModel

      • setVariationContent

        public void setVariationContent​(java.lang.String variationContent)

      • setVariationContentResource

        public void setVariationContentResource​(java.lang.String variationContentResource)

      • setContentId

        public void setContentId​(java.lang.String contentId)

      • setEditable

        public void setEditable​(boolean editable)

      • getVersionTimestamp

        public java.lang.String getVersionTimestamp()
        Description copied from interface: TemplateVariationModel
        Returns the version timestamp for this template variation definition that is used to check if a new template variation 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 TemplateVariationModel

      • setVersionTimestamp

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

      • setParameters

        public void setParameters​(java.util.List<TemplateParameter> parameters)

      • hasVariationContent

        public boolean hasVariationContent()
        Description copied from interface: TemplateVariationModel
        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.
        Specified by:
        hasVariationContent in interface TemplateVariationModel