Package com.flowable.template.api.repository

Class BaseTemplateVariationModel

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

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected java.lang.String contentId  
    protected java.lang.String description  
    protected boolean editable  
    protected java.lang.String externalId  
    protected java.lang.String name  
    protected java.util.List<TemplateParameter> parameters  
    protected java.lang.String templateDefinitionKey  
    protected java.util.Date validFrom  
    protected java.util.Date validTo  
    protected java.lang.String variationContent  
    protected java.lang.String variationContentResource  
    protected java.lang.String variationKey  
    protected java.lang.String versionTimestamp  

  • Constructor Summary

    Constructors 
    Constructor Description
    BaseTemplateVariationModel()  

  • 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 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