TemplateDefinition (Flowable Work 3.10.0)

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

Interface TemplateDefinition

Method Summary

Method Detail

getId

getKey

getVersion

getDeploymentId

getTenantId

getName

getType

getSubType

getFormKey

getResourceName

getCreationTime

getCreatorId

getUpdateTime

getUpdatorId