Package com.aquima.interactions.composer.ds

Interface IComposerDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ComposerDelegateDS, ComposerDS, ComposerDS, ComposerDS, ComposerDS, ReportingComposerDS, XmlComposerDS, XmlComposerDS
public interface IComposerDS extends IReportingDS
This data source defines the methods needed to initialize a composer.
Since:
7.0
Author:
Jon van Leuven

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Category
    CATEGORY
    Category that should be used when reporting errors or warnings that are encountered during initialization.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    iterateContent(IContentVisitor visitor)
    This method should iterate over all the elements that need to be available in the composer, and add them to the provided visitor.
    void
    iterateStyles(IContentStyleVisitor visitor)
    This method should iterate over all the styles that may be used in documents, and add them to the supplied visitor.

    Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

    addMessage

  • Field Details

    • CATEGORY

      static final Category CATEGORY
      Category that should be used when reporting errors or warnings that are encountered during initialization.

  • Method Details

    • iterateContent

      void iterateContent(IContentVisitor visitor)
      This method should iterate over all the elements that need to be available in the composer, and add them to the provided visitor.
      Parameters:
      visitor - The visitor that should be used to add the elements to.
      Throws:
      InitializationException - This exception is thrown when the elements could not be added.

    • iterateStyles

      void iterateStyles(IContentStyleVisitor visitor)
      This method should iterate over all the styles that may be used in documents, and add them to the supplied visitor.

      Note: This method should be invoked before the iterateContent method, as the content depends on style definitions being present.

      Parameters:
      visitor - The visitor that should be used to add the style definitions to.
      Throws:
      InitializationException - This exception is thrown when the style definitions could not be initialized due to a fatal error.