Package com.aquima.interactions.portal.ds

Interface IPortalEngineDS

All Known Implementing Classes:

CompositeDS, MatchPortalEngineDS, StudioBranchDS, StudioDS, StudioRepoDS, XmlPortalEngineDS, XmlPortalEngineDS, XmlPortalEngineDS

public interface IPortalEngineDS

This interface defines the methods that are needed to initialize a portal engine.

Since:

5.0

Author:

O. Kerpershoek

Field Summary

Fields

Modifier and Type	Field	Description
static final Category	CATEGORY	The category used by initialization messages originating from this data-source.

Method Summary

Modifier and Type	Method	Description
IFactoryManager	getDefaultFactoryManager()	This method should return the default factory manager for the portal engine (required).
IResourceManager	getDefaultResourceManager()	This method should return the default resource manager for the portal engine (required).
IApplicationDS	getProjectLoader(ApplicationID id, IInitializationReport report)	This method provides the data-source for the specified project.
ITimer	getTimer()	This method should return a time implementation to act on timed events.
IUserScopeDao	getUserScopeDao()	This method returns the user scope dao that is responsible for storing user specific data across applications and sessions
void	iterateApplications(IApplicationVisitor visitor)	This method should invoke the visitor for each application that this data-source can provide.

Field Details

CATEGORY

static final Category CATEGORY

The category used by initialization messages originating from this data-source.

Method Details

getDefaultResourceManager

IResourceManager getDefaultResourceManager()

This method should return the default resource manager for the portal engine (required).

Returns:

the default resource manager for the portal engine (required).

getDefaultFactoryManager

IFactoryManager getDefaultFactoryManager()

This method should return the default factory manager for the portal engine (required).

Returns:

the default factory manager for the portal engine (required).

getTimer

ITimer getTimer()

This method should return a time implementation to act on timed events.

Returns:

the timer implementation (required).

getUserScopeDao

IUserScopeDao getUserScopeDao()

This method returns the user scope dao that is responsible for storing user specific data across applications and sessions

Returns:

The user scope dao, may not be null

getProjectLoader

IApplicationDS getProjectLoader(ApplicationID id,
 IInitializationReport report)

This method provides the data-source for the specified project.

Parameters:

id - An identifier of the project for which the data-source is requested.

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

Returns:

a new data-source that can provide the data needed to initialize an application.

iterateApplications

void iterateApplications(IApplicationVisitor visitor)

This method should invoke the visitor for each application that this data-source can provide.

Parameters:

visitor - Application visitor that can be used to add the available applications to.