Package com.aquima.interactions.portal.model

Interface IModule

All Superinterfaces:
Serializable
All Known Implementing Classes:
Module
public interface IModule extends Serializable
Interface for the application object containing the static information of an application. The application object must implement this interface to allow platform specific serialization/remoting mechanics by wrapping this interface.
Since:
6.0
Author:
O. Kerpershoek

  • Method Details

    • getId

      ModuleID getId()
      This method returns the ID of the module.
      Returns:
      The ID of the application.

    • getMetaModel

      IMetaModel getMetaModel()
      This method returns the (static) meta model of the application.
      Returns:
      The meta model of the application.

    • getFlowEngine

      IFlowEngine getFlowEngine()
      This method returns the (static) flow engine of the application.
      Returns:
      The flow engine of the application.

    • getRuleEngine

      IRuleEngine getRuleEngine()
      This method returns the (static) rule engine of the application.
      Returns:
      The rule engine of the application.

    • getMatchEngine

      IMatchEngine getMatchEngine()
      This method returns the match engine for this application.
      Returns:
      The match engine of this application.

    • getComposer

      IComposer getComposer()
      This method returns the (static) composer of the application.
      Returns:
      The composer of the application.

    • getTreeEngine

      ITreeEngine getTreeEngine()
      This method returns the (static) tree engine of the application.
      Returns:
      The tree engine of the application.

    • getTraceEngine

      ITraceEngine getTraceEngine()
      Returns the Trace Engine.
      Returns:
      The Trace engine.

    • getServiceCallNames

      String[] getServiceCallNames()
      This method returns an array containing all the service call names.
      Returns:
      array containing all the service call names.

    • getServiceCallDefinition

      IServiceCallDefinition getServiceCallDefinition(String serviceCallName)
      This method returns a (static) service call definition for a specified name.
      Parameters:
      serviceCallName - The service call name used for lookup (case insensitive).
      Returns:
      The service call definition, never null
      Throws:
      UnknownServiceCallException - Is thrown when no service call exists for the given name.

    • getFunctionCallDefinition

      IFunctionCallDefinition getFunctionCallDefinition(String functionCallName)
      This method returns a (static) function call definition for a specified name.
      Parameters:
      functionCallName - The function call name used for lookup (case insensitive).
      Returns:
      The function call definition, never null
      Throws:
      UnknownFunctionCallException - Is thrown when no function call exists for the given name.

    • getDynamicContainerDefinition

      IContainerExpanderDefinition getDynamicContainerDefinition(String name)
      This method returns a (static) dynamic container definition for a specified name.
      Parameters:
      name - The container name used for lookup (case insensitive).
      Returns:
      The dynamic container definition, never null
      Throws:
      UnknownDynamicContainerException - Is thrown when no expander exists for the given name.

    • getMaskCallNames

      String[] getMaskCallNames()
      This method returns an array containing all the mask definition names.
      Returns:
      array containing all the mask definition names.

    • getMaskDefinition

      IMaskCallDefinition getMaskDefinition(String name)
      This method returns a mask definition for a specified name.
      Parameters:
      name - The mask call name used for lookup (case insensitive).
      Returns:
      The mask call definition, never null
      Throws:
      UnknownMaskCallException - Is thrown when no mask call exists for the given name.

    • getCommunicationEngine

      ICommunicationEngine getCommunicationEngine()
      Returns the Communication engine.
      Returns:
      The communication engine.

    • getWebFunctionDataType

      DataValueType getWebFunctionDataType(String functionName)
      This method returns an object containing the contract of the function flow.
      Parameters:
      functionName - The name of the function flow.
      Returns:
      The contract of the function flow.