Package com.aquima.interactions.portal.model

Class Module

java.lang.Object

com.aquima.interactions.portal.model.Module

All Implemented Interfaces:

IModule, Serializable

public class Module
extends Object
implements IModule

This class hold the static data of a specific application version.

This class is not serializable.

Since:

5.0

Author:

O. Kerpershoek

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Module(IProject project, IModuleDS datasource, IFactoryManager factoryManager, IResourceManager resourceManager, IConnectionManager connectionManager, IInitializationReport report, boolean processEnabled, ITraceDao traceDao)	Constructs an application object from the provided data source.

Method Summary

Modifier and Type	Method	Description
ICommunicationEngine	getCommunicationEngine()	Returns the Communication engine.
IComposer	getComposer()	This method returns the (static) composer of the application.
IContainerExpanderDefinition	getDynamicContainerDefinition(String name)	This method returns a (static) dynamic container definition for a specified name.
IFlowEngine	getFlowEngine()	This method returns the (static) flow engine of the application.
IFunctionCallDefinition	getFunctionCallDefinition(String functionCallName)	This method returns a (static) function call definition for a specified name.
ModuleID	getId()	This method returns the ID of the module.
String[]	getMaskCallNames()	This method returns an array containing all the mask definition names.
IMaskCallDefinition	getMaskDefinition(String maskCallName)	This method returns a mask definition for a specified name.
IMatchEngine	getMatchEngine()	This method returns the match engine for this application.
IMetaModel	getMetaModel()	This method returns the (static) meta model of the application.
IRuleEngine	getRuleEngine()	This method returns the (static) rule engine of the application.
IServiceCallDefinition	getServiceCallDefinition(String serviceCallName)	This method returns a (static) service call definition for a specified name.
String[]	getServiceCallNames()	This method returns an array containing all the service call names.
ITraceEngine	getTraceEngine()	Returns the Trace Engine.
ITreeEngine	getTreeEngine()	This method returns the (static) tree engine of the application.
DataValueType	getWebFunctionDataType(String functionName)	This method returns an object containing the contract of the function flow.

Methods inherited from class java.lang.Object

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

Constructor Detail

Module

public Module(IProject project,
              IModuleDS datasource,
              IFactoryManager factoryManager,
              IResourceManager resourceManager,
              IConnectionManager connectionManager,
              IInitializationReport report,
              boolean processEnabled,
              ITraceDao traceDao)
       throws InitializationException

Constructs an application object from the provided data source. NOTE This constructor is public as it is used in test cases.

Parameters:

project - Object containing the project wide definitions.

datasource - The data source providing all the application information.

factoryManager - The factory manager that can be used to locate factory implementations.

resourceManager - The resource manager that can be used to locate external resources like messages.

report - The report that should be used to add initialization messages to.

processEnabled - The process engine that is defined in this module, may be null.

Throws:

InitializationException - This exception is thrown when the application could not be initialized due to errors.

Method Detail

getId

public ModuleID getId()

Description copied from interface: IModule

This method returns the ID of the module.

Specified by:

getId in interface IModule

Returns:

The ID of the application.

getMetaModel

public IMetaModel getMetaModel()

Description copied from interface: IModule

This method returns the (static) meta model of the application.

Specified by:

getMetaModel in interface IModule

Returns:

The meta model of the application.

getFlowEngine

public IFlowEngine getFlowEngine()

Description copied from interface: IModule

This method returns the (static) flow engine of the application.

Specified by:

getFlowEngine in interface IModule

Returns:

The flow engine of the application.

getRuleEngine

public IRuleEngine getRuleEngine()

Description copied from interface: IModule

This method returns the (static) rule engine of the application.

Specified by:

getRuleEngine in interface IModule

Returns:

The rule engine of the application.

getComposer

public IComposer getComposer()

Description copied from interface: IModule

This method returns the (static) composer of the application.

Specified by:

getComposer in interface IModule

Returns:

The composer of the application.

getMatchEngine

public IMatchEngine getMatchEngine()

Description copied from interface: IModule

This method returns the match engine for this application.

Specified by:

getMatchEngine in interface IModule

Returns:

The match engine of this application.

getTreeEngine

public ITreeEngine getTreeEngine()

Description copied from interface: IModule

This method returns the (static) tree engine of the application.

Specified by:

getTreeEngine in interface IModule

Returns:

The tree engine of the application.

getServiceCallNames

public String[] getServiceCallNames()

Description copied from interface: IModule

This method returns an array containing all the service call names.

Specified by:

getServiceCallNames in interface IModule

Returns:

array containing all the service call names.

getServiceCallDefinition

public IServiceCallDefinition getServiceCallDefinition(String serviceCallName)
                                                throws UnknownServiceCallException

Description copied from interface: IModule

This method returns a (static) service call definition for a specified name.

Specified by:

getServiceCallDefinition in interface IModule

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

public IFunctionCallDefinition getFunctionCallDefinition(String functionCallName)
                                                  throws UnknownFunctionCallException

Description copied from interface: IModule

This method returns a (static) function call definition for a specified name.

Specified by:

getFunctionCallDefinition in interface IModule

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

public IContainerExpanderDefinition getDynamicContainerDefinition(String name)
                                                           throws UnknownDynamicContainerException

Description copied from interface: IModule

This method returns a (static) dynamic container definition for a specified name.

Specified by:

getDynamicContainerDefinition in interface IModule

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.

getMaskDefinition

public IMaskCallDefinition getMaskDefinition(String maskCallName)
                                      throws UnknownMaskCallException

Description copied from interface: IModule

This method returns a mask definition for a specified name.

Specified by:

getMaskDefinition in interface IModule

Parameters:

maskCallName - 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.

getMaskCallNames

public String[] getMaskCallNames()

Description copied from interface: IModule

This method returns an array containing all the mask definition names.

Specified by:

getMaskCallNames in interface IModule

Returns:

array containing all the mask definition names.

getCommunicationEngine

public ICommunicationEngine getCommunicationEngine()

Description copied from interface: IModule

Returns the Communication engine.

Specified by:

getCommunicationEngine in interface IModule

Returns:

The communication engine.

getWebFunctionDataType

public DataValueType getWebFunctionDataType(String functionName)
                                     throws UnknownFunctionFlowException

Description copied from interface: IModule

This method returns an object containing the contract of the function flow.

Specified by:

getWebFunctionDataType in interface IModule

Parameters:

functionName - The name of the function flow.

Returns:

The contract of the function flow.

Throws:

UnknownFunctionFlowException

getTraceEngine

public ITraceEngine getTraceEngine()

Description copied from interface: IModule

Returns the Trace Engine.

Specified by:

getTraceEngine in interface IModule

Returns:

The Trace engine.