Package com.aquima.interactions.portal.documents

Interface IRenderedDocument

All Superinterfaces:
Serializable
All Known Implementing Classes:
DocumentResult, RenderedDocument
public interface IRenderedDocument extends Serializable
Interface describing a rendered document.
Since:
6.0
Author:
Jon van Leuven, O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    getContents()
    This method returns the actual contents of the generated document.
    String
    getDescription()
    This method returns a descriptive text of the document.
    String
    getName()
    This method returns the name of the document.
    OutputFormat
    getOutputFormat()
    This method returns the output format of the document.

  • Method Details

    • getName

      String getName()
      This method returns the name of the document.
      Returns:
      The name of the document.

    • getDescription

      String getDescription()
      This method returns a descriptive text of the document.
      Returns:
      a descriptive text of the document, may be null

    • getOutputFormat

      OutputFormat getOutputFormat()
      This method returns the output format of the document.
      Returns:
      The output format of the document.

    • getContents

      byte[] getContents()
      This method returns the actual contents of the generated document.
      Returns:
      byte array containing the actual content of the document.