Package com.aquima.interactions.portal

Interface IDocumentEngine

All Known Implementing Classes:
DocumentEngine
public interface IDocumentEngine
Document engine to be used in the portal engine.
Since:
6.0
Author:
Jon van Leuven

  • Method Details

    • renderDocument

      IRenderedDocument renderDocument(String documentName, OutputFormat format, ILanguage language)
      Compose and render a specific document to a binary document.
      Parameters:
      documentName - The name of the document to generate
      format - The output format of the resulting document
      language - The language used during composition and rendering.
      Returns:
      The resulting document
      Throws:
      AppException - Is thrown when an error occurs during composition or rendering.

    • renderElement

      IRenderedDocument[] renderElement(ICompositeElement element, OutputFormat[] format, ILanguage language)
      Render a composite element to a binary documents for one or more output formats.
      Parameters:
      element - The composite element to generate
      format - The output format(s) of the resulting document, should at least contain one output format.
      language - The language used during composition and rendering.
      Returns:
      The resulting documents
      Throws:
      AppException - Is thrown when an error occurs during composition or rendering.

    • withActiveInstance

      IDocumentEngine withActiveInstance(IEntityInstance instance)
      This method constructs a new document composer with the desired instance defined as an active instance. The returned composer can then be used to construct documents with a specific active-instance.
      Parameters:
      instance - The mandatory instance which should be active within the returned document composer.
      Returns:
      A new document composer with instance context which is never null.

    • withNoActiveInstances

      IDocumentEngine withNoActiveInstances()
      This method constructs a new document composer with no active instances.
      Returns:
      A new document composer with no instance context which is never null.

    • getSupportedFormats

      OutputFormat[] getSupportedFormats()
      This method returns all the output formats that are supported by the current document engine.
      Returns:
      The supported formats, never null