Package com.aquima.interactions.process

Interface IProcessEngineManager

All Known Implementing Classes:

ProcessEngineManager

public interface IProcessEngineManager

Interface for the component that is responsible for loading all the process engines.

Since:

7.1

Author:

J. van Leuven, O. Kerpershoek

Method Summary

Modifier and Type	Method	Description
IProcessEngine	getProcessEngine(IProject project, IProcessModuleDS datasource, IProcessExtensionFactory processExtensionFactory, ITraceEngine traceEngine)	This method initializes and returns a process engine for a specified application/project.
IProcessEngine	getProcessEngine(String projectName, Version projectVersion, ModuleID moduleId, IProcessExtensionFactory processExtensionFactory, ITraceEngine traceEngine)	This method returns a process engine for a specified application/project.
IProcessEngineSettings	getProcessEngineSettings()	This method returns the process engine settings which will be used by all process engine instances created by this manager.
IInitializationReport	getReport(String projectName, Version projectVersion, ModuleID projectId, IProcessExtensionFactory processExtensionFactory, ITraceEngine traceEngine)	This method returns the initialization report of a process engine.
boolean	resetCache()	Clears the process engine cache.
boolean	resetCache(String moduleName)	This method may be invoked to reset the process engine cache for a specific process module.
void	setDomainValuesFactory(IDomainValuesFactory domainValuesFactory)	This method can be used to set an optional domain values factory that will be used for all process engines that are available in this manager.

Method Detail

getProcessEngine

IProcessEngine getProcessEngine(String projectName,
                                Version projectVersion,
                                ModuleID moduleId,
                                IProcessExtensionFactory processExtensionFactory,
                                ITraceEngine traceEngine)
                         throws UnknownProcessModuleException,
                                InitializationException

This method returns a process engine for a specified application/project. If no process engine is defined for the application null will be returned.

Parameters:

projectName - The name of the process engine to return.

projectVersion - The project version of the process engine to return.

moduleId - The module id of the process engine to return.

Returns:

The process engine implementation, may be null.

Throws:

UnknownProcessModuleException - This exception is thrown when the module ID is not registered with the manager.

InitializationException - When the process engine could not be initialized.

getProcessEngine

IProcessEngine getProcessEngine(IProject project,
                                IProcessModuleDS datasource,
                                IProcessExtensionFactory processExtensionFactory,
                                ITraceEngine traceEngine)
                         throws UnknownProcessModuleException,
                                InitializationException

This method initializes and returns a process engine for a specified application/project.

Parameters:

project - Project containing various global definitions.

datasource - Object providing the information needed to initialize a process engine.

Returns:

The process engine implementation, may be null.

Throws:

UnknownProcessModuleException - This exception is thrown when the module ID is not registered with the manager.

InitializationException - When the process engine could not be initialized.

getProcessEngineSettings

IProcessEngineSettings getProcessEngineSettings()

This method returns the process engine settings which will be used by all process engine instances created by this manager.

Returns:

the process engine settings

getReport

IInitializationReport getReport(String projectName,
                                Version projectVersion,
                                ModuleID projectId,
                                IProcessExtensionFactory processExtensionFactory,
                                ITraceEngine traceEngine)
                         throws UnknownProcessModuleException

This method returns the initialization report of a process engine. If no process engine is defined for the application null will be returned.

Parameters:

projectName - The name of the process engine report to return.

projectVersion - The project version of the process engine report to return.

projectId - The id that specifies which process engine report to return.

Returns:

The initialization report, may be null.

Throws:

UnknownProcessModuleException - This exception is thrown when the module ID is not registered with the manager.

resetCache

boolean resetCache(String moduleName)

This method may be invoked to reset the process engine cache for a specific process module.

Parameters:

moduleName - The name of the process module for which the cache should be cleared.

Returns:

Boolean indicating if the operation was successful.

resetCache

boolean resetCache()

Clears the process engine cache.

Returns:

boolean indicating if the operation was successful.

setDomainValuesFactory

void setDomainValuesFactory(IDomainValuesFactory domainValuesFactory)

This method can be used to set an optional domain values factory that will be used for all process engines that are available in this manager.

Note: Some implementations may use lazy loading to initialize the process engines, so setting a domain factory after a process engine is initialized will not effect the already initialized process engines.

Parameters:

domainValuesFactory - The optional domain factory.