Interface TemplateProcessingResult

All Known Implementing Classes:
DefaultTemplateProcessingResult
public interface TemplateProcessingResult
A template processing result represents the result from a processed TemplateVariationDefinition through a TemplateProcessor.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.flowable.content.api.ContentItem
    getContentItem()
    If the processed result is stored as a content item document, this will return it.
    String
    getDocumentName()
    Returns the document name with the appropriate extension applied (e.g.
    InputStream
    getInputStream()
    Returns the processed result as an InputStream.
    String
    getMimeType()
    Returns the mime type of the produced document (e.g.
    String
    getProcessedContent()
    Returns the processed content as a string (in case the content is processed directly).
    TemplateHolder
    getTemplateHolder()
    Returns the template holder containing all information like template definition and variation which was used to produce the result.

  • Method Details

    • getProcessedContent

      String getProcessedContent()
      Returns the processed content as a string (in case the content is processed directly).

    • getInputStream

      InputStream getInputStream()
      Returns the processed result as an InputStream. Callers are responsible for closing the stream.

    • getContentItem

      org.flowable.content.api.ContentItem getContentItem()
      If the processed result is stored as a content item document, this will return it.

    • getMimeType

      String getMimeType()
      Returns the mime type of the produced document (e.g. "application/pdf"), or null if this result is not a document.

    • getDocumentName

      String getDocumentName()
      Returns the document name with the appropriate extension applied (e.g. "myDoc.docx"), or null if this result is not a document.

    • getTemplateHolder

      TemplateHolder getTemplateHolder()
      Returns the template holder containing all information like template definition and variation which was used to produce the result.