Package com.aquima.interactions.portal.report

Class ReportingApplicationDS

java.lang.Object

com.aquima.interactions.foundation.report.ReportingDS

com.aquima.interactions.portal.report.ReportingModuleDS

com.aquima.interactions.portal.report.ReportingApplicationDS

All Implemented Interfaces:

IReportingDS, IApplicationDS, IModuleDS

public class ReportingApplicationDS
extends ReportingModuleDS
implements IApplicationDS

IApplicationDS implementation that adds error reporting.

Since:

5.0

Author:

O. Kerpershoek, F. van der Meer

Constructor Summary

Constructors

Constructor	Description
ReportingApplicationDS(IInitializationReport report, IApplicationDS datasource)	Constructs the application data source with the required parameters.

Method Summary

Modifier and Type	Method	Description
ApplicationID	getApplicationId()	This method returns the ID of the application.
ApplicationMode	getApplicationMode()	This method returns the application mode for the portal engine.
IConnectionManager	getConnectionManager()	This method may return an application specific connection manager.
IFactoryManager	getFactoryManager()	This method should return a factory manager implementation for the application.
IProcessModuleDS	getProcessEngine()	This method returns the module containing process definitions.
IProcessMappingDS	getProcessMappingDS()	This method returns the mapping that should be used for the processes.
IProjectDS	getProjectDS()	This method returns the data source that should be used to initialize the objects that are defined project wide and used by all modules in the project.
ProjectMetadata	getProjectMetadata()	Returns the project metadata containing webservice calls and library references
IResourceManager	getResourceManager()	This method should return a resource manager implementation for the application.
ITimelineCreator	getTimelineCreator()	Returns the timeline dao that will be used by the trace engine
ITraceDao	getTraceDao()	Returns the trace dao that will be used by the trace engine
boolean	isContinueOnFailedDocument()	This method returns a boolean indicating if a document may contain failed elements, or that the cause of the failure should be thrown as an exception.
void	iterateMappings(IMappingVisitor visitor)	This method should iterate over all the mappings and add them to the provided visitor.
void	iterateModules(IModuleVisitor visitor)	This method should iterate over all modules that are used by the application, and add a data source implementation for each of them to the visitor.
void	iterateWebServices(IWebServiceVisitor visitor)	This method should iterate over all the exposed web services and add them to the provided visitor.
boolean	outputFailedMasks()	This method returns a boolean indicating if failed masks must be included, or that the cause of the failure should be thrown as an exception.
boolean	wrapFailedElements()	This method returns a boolean indicating if elements that fail expansion should be replaced by failed element objects, or that the cause of the failure should be thrown as an exception.

Methods inherited from class com.aquima.interactions.portal.report.ReportingModuleDS

cachingEnabled, getCommunicationEngineDS, getComposerDS, getFlowEngineDS, getMatchEngineDS, getMetaModelDS, getModuleId, getRuleEngineDS, getTreeEngineDS, iterateContainerExpanders, iterateFunctionCalls, iterateMaskCalls, iterateServiceCalls

Methods inherited from class com.aquima.interactions.foundation.report.ReportingDS

addError, addMessage, getCategory, getReport

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.portal.ds.IModuleDS

cachingEnabled, getCommunicationEngineDS, getComposerDS, getFlowEngineDS, getMatchEngineDS, getMetaModelDS, getModuleId, getRuleEngineDS, getTreeEngineDS, iterateContainerExpanders, iterateFunctionCalls, iterateMaskCalls, iterateServiceCalls

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

addMessage

Constructor Details

ReportingApplicationDS

public ReportingApplicationDS(IInitializationReport report,
 IApplicationDS datasource)

Constructs the application data source with the required parameters.

Parameters:

report - The initialization report to add error/warning to.

datasource - The data source that is wrapped by this data source.

Throws:

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

Method Details

getApplicationId

public ApplicationID getApplicationId()

Description copied from interface: IApplicationDS

This method returns the ID of the application.

Specified by:

getApplicationId in interface IApplicationDS

Returns:

the ID of the application.

getResourceManager

public IResourceManager getResourceManager()

Description copied from interface: IApplicationDS

This method should return a resource manager implementation for the application.

Specified by:

getResourceManager in interface IApplicationDS

Returns:

a resource manager implementation for the application.

getConnectionManager

public IConnectionManager getConnectionManager()

Description copied from interface: IApplicationDS

This method may return an application specific connection manager.

Specified by:

getConnectionManager in interface IApplicationDS

Returns:

an application specific connection manager, or null if no predefined connections are available in the application.

getApplicationMode

public ApplicationMode getApplicationMode()

Description copied from interface: IApplicationDS

This method returns the application mode for the portal engine.

Specified by:

getApplicationMode in interface IApplicationDS

Returns:

The application mode for the portal engine.

getFactoryManager

public IFactoryManager getFactoryManager()

Description copied from interface: IApplicationDS

This method should return a factory manager implementation for the application.

Specified by:

getFactoryManager in interface IApplicationDS

Returns:

a factory manager implementation for the application.

getProcessMappingDS

public IProcessMappingDS getProcessMappingDS()

Description copied from interface: IApplicationDS

This method returns the mapping that should be used for the processes. If the application does not use a process engine, as null value should be returned. Usually an application using a process engine does not define any processes.

Specified by:

getProcessMappingDS in interface IApplicationDS

Returns:

the mapping that should be used for the processes.

getProjectDS

public IProjectDS getProjectDS()

Description copied from interface: IApplicationDS

This method returns the data source that should be used to initialize the objects that are defined project wide and used by all modules in the project.

Specified by:

getProjectDS in interface IApplicationDS

Returns:

Data source providing the definitions of the global objects.

iterateModules

public void iterateModules(IModuleVisitor visitor)

Description copied from interface: IApplicationDS

This method should iterate over all modules that are used by the application, and add a data source implementation for each of them to the visitor.

Specified by:

iterateModules in interface IApplicationDS

Parameters:

visitor - The visitor that should be used to add the module data sources to.

getProcessEngine

public IProcessModuleDS getProcessEngine()

Description copied from interface: IApplicationDS

This method returns the module containing process definitions. When no process engine is used this will return null

Specified by:

getProcessEngine in interface IApplicationDS

Returns:

the module containing the process definitions

iterateMappings

public void iterateMappings(IMappingVisitor visitor)

Description copied from interface: IApplicationDS

This method should iterate over all the mappings and add them to the provided visitor.

Specified by:

iterateMappings in interface IApplicationDS

Parameters:

visitor - The visitor that should be used to add the mapping definitions to.

outputFailedMasks

public boolean outputFailedMasks()

Description copied from interface: IApplicationDS

This method returns a boolean indicating if failed masks must be included, or that the cause of the failure should be thrown as an exception.

Specified by:

outputFailedMasks in interface IApplicationDS

Returns:

a boolean indicating if mask that fails should be included in the expanded element

wrapFailedElements

public boolean wrapFailedElements()

Description copied from interface: IApplicationDS

This method returns a boolean indicating if elements that fail expansion should be replaced by failed element objects, or that the cause of the failure should be thrown as an exception.

Specified by:

wrapFailedElements in interface IApplicationDS

Returns:

a boolean indicating if elements that fail expansion should be replaced by failed element objects.

isContinueOnFailedDocument

public boolean isContinueOnFailedDocument()

Description copied from interface: IApplicationDS

This method returns a boolean indicating if a document may contain failed elements, or that the cause of the failure should be thrown as an exception.

Specified by:

isContinueOnFailedDocument in interface IApplicationDS

Returns:

a boolean indicating if a document may contain failed elements.

iterateWebServices

public void iterateWebServices(IWebServiceVisitor visitor)

Description copied from interface: IApplicationDS

This method should iterate over all the exposed web services and add them to the provided visitor.

Specified by:

iterateWebServices in interface IApplicationDS

Parameters:

visitor - The visitor that should be used to add the exposed web service definitions to.

getTraceDao

public ITraceDao getTraceDao()

Description copied from interface: IApplicationDS

Returns the trace dao that will be used by the trace engine

Specified by:

getTraceDao in interface IApplicationDS

Returns:

getTimelineCreator

public ITimelineCreator getTimelineCreator()

Description copied from interface: IApplicationDS

Returns the timeline dao that will be used by the trace engine

Specified by:

getTimelineCreator in interface IApplicationDS

Returns:

The Timeline Creator DAO

getProjectMetadata

public ProjectMetadata getProjectMetadata()

Description copied from interface: IApplicationDS

Returns the project metadata containing webservice calls and library references

Specified by:

getProjectMetadata in interface IApplicationDS

Returns: