Package com.flowable.template.api.repository

Interface TemplateDefinition

  • All Known Subinterfaces:
    TemplateDefinitionEntity
    All Known Implementing Classes:
    TemplateDefinitionEntityImpl
    public interface TemplateDefinition
    A template definition can be used for any sort of template (e.g. a document-, message- or email-template, etc). It contains the meta information about a single template and is classified using getType() and getSubType() where the type will later be used to lookup a renderer able to render or further process this template. A template might contain one or more variations (e.g. for multiple languages) represented with TemplateVariationDefinition. Each one of the variations has its own content mapped to a single VariationDefinition (e.g. for a single language in a country, etc).
    Author:
    Micha Kiener

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Date getCreationTime()
      Returns the creation time of this definition.
      java.lang.String getCreatorId()
      Returns the id of the user creating this template definition.
      java.lang.String getDeploymentId()
      Returns the deployment id this definition was deployed with.
      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 getId()
      Returns the unique id of this template definition.
      java.lang.String getKey()
      Returns the business key usually used to reference or lookp a template definition regardless of its version.
      java.lang.String getName()
      Returns the name of this template definition.
      java.lang.String getResourceName()
      Returns the name of the resource this definition is based on.
      java.lang.String getSubType()
      Returns the sub type of this template definition which can be freely chosen.
      java.lang.String getTenantId()
      Returns the id of the tenant this definition belongs to.
      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.util.Date getUpdateTime()
      Returns the last update time of this definition.
      java.lang.String getUpdatorId()
      Returns the id of the user last updating this template definition.
      int getVersion()
      Return the version of this template definition.

    • Method Detail

      • getId

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

      • getKey

        java.lang.String getKey()
        Returns the business key usually used to reference or lookp a template definition regardless of its version.

      • getVersion

        int getVersion()
        Return the version of this template definition.

      • getDeploymentId

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

      • getTenantId

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

      • getName

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

      • getType

        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.
        See Also:
        for a set of predefined template types

      • getSubType

        java.lang.String getSubType()
        Returns the sub type of this template definition which can be freely chosen.

      • getFormKey

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

      • getResourceName

        java.lang.String getResourceName()
        Returns the name of the resource this definition is based on.

      • getCreationTime

        java.util.Date getCreationTime()
        Returns the creation time of this definition.

      • getCreatorId

        java.lang.String getCreatorId()
        Returns the id of the user creating this template definition.

      • getUpdateTime

        java.util.Date getUpdateTime()
        Returns the last update time of this definition.

      • getUpdatorId

        java.lang.String getUpdatorId()
        Returns the id of the user last updating this template definition.