TemplateSourceDocument (Nuxeo ECM Projects 8.10-SNAPSHOT API)

All Known Implementing Classes:

TemplateSourceDocumentAdapterImpl
```
public interface TemplateSourceDocument
```
It is mainly the source used by TemplateBasedDocument to handle the rendering.

Author:

Tiry (tdelprat@nuxeo.com)

Field Summary

Fields
Modifier and Type Field and Description

static String INIT_DONE_FLAG

Fields
Modifier and Type	Field and Description
`static String`	`INIT_DONE_FLAG`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<TemplateInput>`	`addInput(TemplateInput input)` Add or update a `TemplateInput` to the list of template parameters.
`boolean`	`allowInstanceOverride()` Return flag to indicate if Documents associated to this template can override parametes value
`DocumentModel`	`getAdaptedDoc()` Return the underlying adapted `DocumentModel`s
`List<String>`	`getApplicableTypes()` Get List of Document Types than can be associated to this Template.
`String`	`getFileName()` Shortcut to access the underlying `Blob` filename
`List<String>`	`getForcedTypes()` Get List of Document Types that must be automatically bound to this template at creation time
`String`	`getId()` Shortcut to access the underlying `DocumentModel` uuid
`String`	`getLabel()` Return label key used for template
`String`	`getName()` Shortcut to access the underlying `DocumentModel` name
`String`	`getOutputFormat()` Return the expected mime-type of the resulting rendering
`List<TemplateInput>`	`getParams()` Retrieve the parameters associated to the Template file
`String`	`getParamsAsString()` Return the String representation of the parameters of the template
`String`	`getTargetRenditionName()` Get the associated Rendition if any
`List<TemplateBasedDocument>`	`getTemplateBasedDocuments()` Get the list of `TemplateBasedDocument`s associated to this template
`Blob`	`getTemplateBlob()` Retrieve the Blob holding the template file
`String`	`getTemplateType()` Return the template Type (i.e.
`String`	`getTitle()` Shortcut to access the underlying `DocumentModel` title
`String`	`getVersionLabel()` Shortcut to access the underlying `DocumentModel` versionLabel
`boolean`	`hasEditableParams()` Indicate of the associated Template has editable parameters or not
`boolean`	`hasInput(String inputName)` Returns whether or not the `TemplateInput` already exists, based on the name, in the template.
`void`	`initTemplate(boolean save)` Initialize the DocumentModel finds associated TemplateProcessor extract Template parameters
`void`	`initTypesBindings()` Initialize the Types2Template binding
`void`	`removeForcedType(String type, boolean save)` Remove Type mapping for this template
`DocumentModel`	`save()` Save changes in the underlying `DocumentModel`
`DocumentModel`	`saveParams(List<TemplateInput> params, boolean save)` Save parameters changes
`void`	`setForcedTypes(String[] forcedTypes, boolean save)` Update the Type mapping for this template
`void`	`setOutputFormat(String mimetype, boolean save)` Sets the expected output mime-type.
`void`	`setTargetRenditioName(String renditionName, boolean save)` Associate Template to a Rendition
`void`	`setTemplateBlob(Blob blob, boolean save)` Write accessor to the `Blob` used to store the template
`boolean`	`useAsMainContent()` Indicate if the template can be used as main blob in the `TemplateBasedDocument` (i.e.

- Field Detail
  - INIT_DONE_FLAG
```
static final String INIT_DONE_FLAG
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getParamsAsString
```
String getParamsAsString()
                  throws PropertyException
```
    Return the String representation of the parameters of the template
    
    Throws:
    
    PropertyException
  - addInput
```
List<TemplateInput> addInput(TemplateInput input)
```
    Add or update a TemplateInput to the list of template parameters.
  - hasInput
```
boolean hasInput(String inputName)
```
    Returns whether or not the TemplateInput already exists, based on the name, in the template.
  - getTemplateType
```
String getTemplateType()
```
    Return the template Type (i.e. the associated TemplateProcessor name.
    
    Returns:
    
    TemplateProcessor name if any, null otherwise
  - initTemplate
```
void initTemplate(boolean save)
```
    Initialize the DocumentModel
    - finds associated TemplateProcessor
    - extract Template parameters
    Parameters:
    
    save - flag to indicate if target DocumentModel must be saved or not
  - initTypesBindings
```
void initTypesBindings()
```
    Initialize the Types2Template binding
  - getTemplateBlob
```
Blob getTemplateBlob()
              throws PropertyException
```
    Retrieve the Blob holding the template file
    
    Throws:
    
    PropertyException
  - getParams
```
List<TemplateInput> getParams()
                       throws PropertyException
```
    Retrieve the parameters associated to the Template file
    
    Throws:
    
    PropertyException
  - saveParams
```
DocumentModel saveParams(List<TemplateInput> params,
                         boolean save)
```
    Save parameters changes
    
    Parameters:
    
    params - the updated list of parameters
    
    save - flag to indicate if target DocumentModel must be saved or not
    
    Returns:
    
    the updated DocumentModel
  - getAdaptedDoc
```
DocumentModel getAdaptedDoc()
```
    Return the underlying adapted DocumentModels
  - save
```
DocumentModel save()
```
    Save changes in the underlying DocumentModel
  - allowInstanceOverride
```
boolean allowInstanceOverride()
```
    Return flag to indicate if Documents associated to this template can override parametes value
  - hasEditableParams
```
boolean hasEditableParams()
```
    Indicate of the associated Template has editable parameters or not
  - getApplicableTypes
```
List<String> getApplicableTypes()
```
    Get List of Document Types than can be associated to this Template.
    
    Returns:
    
    List of Document Types or an empty List
  - getForcedTypes
```
List<String> getForcedTypes()
```
    Get List of Document Types that must be automatically bound to this template at creation time
    
    Returns:
    
    List of Document Types or an empty List
  - getTemplateBasedDocuments
```
List<TemplateBasedDocument> getTemplateBasedDocuments()
```
    Get the list of TemplateBasedDocuments associated to this template
  - removeForcedType
```
void removeForcedType(String type,
                      boolean save)
```
    Remove Type mapping for this template
  - setForcedTypes
```
void setForcedTypes(String[] forcedTypes,
                    boolean save)
```
    Update the Type mapping for this template
  - setOutputFormat
```
void setOutputFormat(String mimetype,
                     boolean save)
```
    Sets the expected output mime-type. If the expected mime-type is different from the output of the rendering, converters will be applied.
  - getOutputFormat
```
String getOutputFormat()
```
    Return the expected mime-type of the resulting rendering
  - useAsMainContent
```
boolean useAsMainContent()
```
    Indicate if the template can be used as main blob in the TemplateBasedDocument (i.e. if the template is editable by the end user)
  - getName
```
String getName()
```
    Shortcut to access the underlying DocumentModel name
  - getFileName
```
String getFileName()
```
    Shortcut to access the underlying Blob filename
    
    Returns:
    
    name
  - getTitle
```
String getTitle()
```
    Shortcut to access the underlying DocumentModel title
    
    Returns:
    
    template filename
  - getVersionLabel
```
String getVersionLabel()
```
    Shortcut to access the underlying DocumentModel versionLabel
    
    Returns:
    
    versionLabel
  - getId
```
String getId()
```
    Shortcut to access the underlying DocumentModel uuid
    
    Returns:
    
    UUID
  - getLabel
```
String getLabel()
```
    Return label key used for template
  - setTargetRenditioName
```
void setTargetRenditioName(String renditionName,
                           boolean save)
```
    Associate Template to a Rendition
  - getTargetRenditionName
```
String getTargetRenditionName()
```
    Get the associated Rendition if any
    
    Returns:
    
    Rendition name or null
  - setTemplateBlob
```
void setTemplateBlob(Blob blob,
                     boolean save)
```
    Write accessor to the Blob used to store the template

Interface TemplateSourceDocument

Field Summary

Method Summary

Field Detail

INIT_DONE_FLAG

Method Detail

getParamsAsString

addInput

hasInput

getTemplateType

initTemplate

initTypesBindings

getTemplateBlob

getParams

saveParams

getAdaptedDoc

save

allowInstanceOverride

hasEditableParams

getApplicableTypes

getForcedTypes

getTemplateBasedDocuments

removeForcedType

setForcedTypes

setOutputFormat

getOutputFormat

useAsMainContent

getName

getFileName

getTitle

getVersionLabel

getId

getLabel

setTargetRenditioName

getTargetRenditionName

setTemplateBlob