Package com.aquima.interactions.portal.ds.sys

Class ModuleDS

java.lang.Object

com.aquima.interactions.portal.report.ReportingDelegate

com.aquima.interactions.portal.ds.sys.ModuleDS

All Implemented Interfaces:

IReportingDS, IModuleDS

public class ModuleDS
extends ReportingDelegate
implements IModuleDS

Portal engine data source wrapper that adds the system entity and resource messages.

Since:

6.0

Author:

O. Kerpershoek

Constructor Summary

Constructors

Constructor	Description
ModuleDS(IModuleDS datasource, boolean processEnabled)	Constructs the data source with the original data source that should be wrapped.

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 class com.aquima.interactions.portal.report.ReportingDelegate

addMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addMessage

Constructor Detail

ModuleDS

public ModuleDS(IModuleDS datasource,
                boolean processEnabled)
         throws InitializationException

Constructs the data source with the original data source that should be wrapped.

Parameters:

datasource - the original data source that should be wrapped.

processEnabled - Boolean indicating if process related pre-processing should be done (i.e. replace flow nodes).

Throws:

InitializationException - This exception is thrown when model could not be initialized.

Method Detail

getModuleId

public ModuleID getModuleId()

Description copied from interface: IModuleDS

This method should return the unique identifier of the application. The identifier consists of the application name and version.

Specified by:

getModuleId in interface IModuleDS

Returns:

The unique identifier of the application.

cachingEnabled

public boolean cachingEnabled()

Description copied from interface: IModuleDS

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.

Specified by:

cachingEnabled in interface IModuleDS

Returns:

boolean Boolean indicating if application models should be cached.

getFlowEngineDS

public IFlowEngineDS getFlowEngineDS()

Description copied from interface: IModuleDS

This method should return a datasource implementation that can be used to initialize the flow engine for the application.

Specified by:

getFlowEngineDS in interface IModuleDS

Returns:

Flow engine datasource implementation for the current application.

getMetaModelDS

public IMetaModelDS getMetaModelDS()

Description copied from interface: IModuleDS

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.

Specified by:

getMetaModelDS in interface IModuleDS

Returns:

IMetaModelDS implementation for the application.

getRuleEngineDS

public IRuleEngineDS getRuleEngineDS()

Description copied from interface: IModuleDS

This method should return a datasource implementation that can be used to initialize the rule engine for the application.

Specified by:

getRuleEngineDS in interface IModuleDS

Returns:

Rule engine datasource implementation for the current application.

getTreeEngineDS

public ITreeEngineDS getTreeEngineDS()

Description copied from interface: IModuleDS

This method should return a datasource implementation that can be used to initialize the tree engine for the application.

Specified by:

getTreeEngineDS in interface IModuleDS

Returns:

Tree engine datasource implementation for the current application.

getMatchEngineDS

public IMatchEngineDS getMatchEngineDS()

Description copied from interface: IModuleDS

This method should return a data source implementation that can be used to initialize a match engine for the application.

Specified by:

getMatchEngineDS in interface IModuleDS

Returns:

The match engine data-source implementation.

getComposerDS

public IComposerDS getComposerDS()

Description copied from interface: IModuleDS

This method should return a datasource implementation that can be used to initialize the composer for the application.

Specified by:

getComposerDS in interface IModuleDS

Returns:

Composer datasource implementation for the current application.

iterateServiceCalls

public void iterateServiceCalls(IServiceCallVisitor visitor)
                         throws InitializationException

Description copied from interface: IModuleDS

This method should iterate over all the service calls and invoke the visitor for each call definition that should be added.

Specified by:

iterateServiceCalls in interface IModuleDS

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

public void iterateFunctionCalls(IFunctionCallVisitor visitor)
                          throws InitializationException

Description copied from interface: IModuleDS

This method should iterate over all the function calls and invoke the visitor for each call definition that should be added.

Specified by:

iterateFunctionCalls in interface IModuleDS

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.

iterateContainerExpanders

public void iterateContainerExpanders(IContainerExpanderVisitor visitor)
                               throws InitializationException

Description copied from interface: IModuleDS

This method should iterate over all the (dynamic) container expanders, and invoke the visitor for each call definition that should be added.

Specified by:

iterateContainerExpanders in interface IModuleDS

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.

iterateMaskCalls

public void iterateMaskCalls(IMaskCallVisitor visitor)
                      throws InitializationException

Description copied from interface: IModuleDS

This method should iterate over all the mask calls and invoke the visitor for each call definition that should be added.

Specified by:

iterateMaskCalls in interface IModuleDS

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.

getCommunicationEngineDS

public ICommunicationEngineDS getCommunicationEngineDS()

Description copied from interface: IModuleDS

This method should return a datasource implementation that can be used to initialize the communication engine for the application.

Specified by:

getCommunicationEngineDS in interface IModuleDS

Returns:

Communication engine datasource implementation for the current application.