Package com.aquima.interactions.portal.ds

Interface IModuleDS

All Superinterfaces:
IReportingDS
All Known Subinterfaces:
IApplicationDS
All Known Implementing Classes:
ApplicationDelegateDS, ApplicationDS, ConfigApplicationDS, ConfigApplicationDS, ConfigModuleDS, ConfigModuleDS, ExtXmlMatchApplicationDS, ExtXmlMatchModuleDS, ModuleDelegateDS, ModuleDS, ModuleDS, PrefixedApplicationDS, ReportingApplicationDS, ReportingModuleDS, XmlApplicationDS, XmlApplicationDS, XmlModuleDS, XmlModuleDS
public interface IModuleDS extends IReportingDS
This data-source interface is used to initialise an application. The implementation of this interface is requested by the portal engine through the IPortalEngineDS interface.
Since:
5.0
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    cachingEnabled()
    Indicating if models should be cached on the server.
    ICommunicationEngineDS
    getCommunicationEngineDS()
    This method should return a datasource implementation that can be used to initialize the communication engine for the application.
    IComposerDS
    getComposerDS()
    This method should return a datasource implementation that can be used to initialize the composer for the application.
    IFlowEngineDS
    getFlowEngineDS()
    This method should return a datasource implementation that can be used to initialize the flow engine for the application.
    IMatchEngineDS
    getMatchEngineDS()
    This method should return a data source implementation that can be used to initialize a match engine for the application.
    IMetaModelDS
    getMetaModelDS()
    This method should return a meta-model datasource implementation for the application this interface represents.
    ModuleID
    getModuleId()
    This method should return the unique identifier of the application.
    IRuleEngineDS
    getRuleEngineDS()
    This method should return a datasource implementation that can be used to initialize the rule engine for the application.
    ITreeEngineDS
    getTreeEngineDS()
    This method should return a datasource implementation that can be used to initialize the tree engine for the application.
    void
    iterateContainerExpanders(IContainerExpanderVisitor visitor)
    This method should iterate over all the (dynamic) container expanders, and invoke the visitor for each call definition that should be added.
    void
    iterateFunctionCalls(IFunctionCallVisitor visitor)
    This method should iterate over all the function calls and invoke the visitor for each call definition that should be added.
    void
    iterateMaskCalls(IMaskCallVisitor visitor)
    This method should iterate over all the mask calls and invoke the visitor for each call definition that should be added.
    void
    iterateServiceCalls(IServiceCallVisitor visitor)
    This method should iterate over all the service calls and invoke the visitor for each call definition that should be added.

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

    addMessage

  • Method Details

    • cachingEnabled

      boolean cachingEnabled()
      Indicating if models should be cached on the server. At the moment the caching is enabled or disabled for all applications running on the server.
      Returns:
      boolean indicating if application models should be cached.

    • getModuleId

      ModuleID getModuleId()
      This method should return the unique identifier of the application. The identifier consists of the application name and version.
      Returns:
      The unique identifier of the application.

    • getMetaModelDS

      IMetaModelDS getMetaModelDS()
      This method should return a meta-model datasource implementation for the application this interface represents. The returned datasource will be used to initialize the meta-model component.
      Returns:
      IMetaModelDS implementation for the application.

    • getRuleEngineDS

      IRuleEngineDS getRuleEngineDS()
      This method should return a datasource implementation that can be used to initialize the rule engine for the application.
      Returns:
      Rule engine datasource implementation for the current application.

    • getComposerDS

      IComposerDS getComposerDS()
      This method should return a datasource implementation that can be used to initialize the composer for the application.
      Returns:
      Composer datasource implementation for the current application.

    • getFlowEngineDS

      IFlowEngineDS getFlowEngineDS()
      This method should return a datasource implementation that can be used to initialize the flow engine for the application.
      Returns:
      Flow engine datasource implementation for the current application.

    • getTreeEngineDS

      ITreeEngineDS getTreeEngineDS()
      This method should return a datasource implementation that can be used to initialize the tree engine for the application.
      Returns:
      Tree engine datasource implementation for the current application.

    • getMatchEngineDS

      IMatchEngineDS getMatchEngineDS()
      This method should return a data source implementation that can be used to initialize a match engine for the application.
      Returns:
      The match engine data-source implementation.

    • iterateServiceCalls

      void iterateServiceCalls(IServiceCallVisitor visitor)
      This method should iterate over all the service calls and invoke the visitor for each call definition that should be added.
      Parameters:
      visitor - The visitor that should be used to add service call definitions to.
      Throws:
      InitializationException - This exception is thrown when the service call could not be initialized.

    • iterateFunctionCalls

      void iterateFunctionCalls(IFunctionCallVisitor visitor)
      This method should iterate over all the function calls and invoke the visitor for each call definition that should be added.
      Parameters:
      visitor - The visitor that should be used to add function call definitions to.
      Throws:
      InitializationException - This exception is thrown when the function call could not be initialized.

    • iterateMaskCalls

      void iterateMaskCalls(IMaskCallVisitor visitor)
      This method should iterate over all the mask calls and invoke the visitor for each call definition that should be added.
      Parameters:
      visitor - The visitor that should be used to add mask call definitions to.
      Throws:
      InitializationException - This exception is thrown when the mask call could not be initialized.

    • iterateContainerExpanders

      void iterateContainerExpanders(IContainerExpanderVisitor visitor)
      This method should iterate over all the (dynamic) container expanders, and invoke the visitor for each call definition that should be added.
      Parameters:
      visitor - The visitor that should be used to add dynamic container expander definitions to.
      Throws:
      InitializationException - This exception is thrown when the container expander(s) could not be initialized.

    • getCommunicationEngineDS

      ICommunicationEngineDS getCommunicationEngineDS()
      This method should return a datasource implementation that can be used to initialize the communication engine for the application.
      Returns:
      Communication engine datasource implementation for the current application.