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

Class ProjectDS

java.lang.Object

com.aquima.interactions.portal.ds.sys.project.ProjectDS

All Implemented Interfaces:

IReportingDS, IProjectDS

public class ProjectDS
extends Object
implements IProjectDS

Project data-source implementation that adds messages from message property files.

Since:

7.1

Author:

O. Kerpershoek

Field Summary

Fields inherited from interface com.aquima.interactions.project.ds.IProjectDS

CATEGORY

Constructor Summary

Constructors

Constructor	Description
ProjectDS(IProjectDS datasource, IResourceManager resourceManager)	Constructs the project data-source with an existing data-source implementation that will be used as fall back.

Method Summary

Modifier and Type	Method	Description
void	addMessage(ErrorCode code, String[] parameters, Severity severity)	This method will add an initialization error to the report for the specified error code and parameters.
String	getApiDocumentation()	This method returns the api documentation.
String	getApiTitle()	This method returns the api title.
String	getDefaultLanguageName()	Returns the name of the default language, null when not specified.
String	getDefaultThemeName()	Returns the name of the default theme, null when not specified.
String	getName()	This method returns the unique name of the application.
Version	getVersion()	This method returns the version of the application.
void	iterateChannels(IChannelVisitor visitor)	This method should iterate over the various channels that are available in the application.
void	iterateConnections(IConnectionVisitor visitor)	This method should iterate over all the connections and add them to the provided visitor.
void	iterateExpanders(IExpanderVisitor visitor)	This method should iterate over all the expander definitions and add them to the provided visitor.
void	iterateFieldTypes(IFieldTypeVisitor visitor)
void	iterateGlobalParameters(IGlobalParameterVisitor visitor)
void	iterateLanguages(ILanguageVisitor visitor)	This method should iterate over the available languages and add them to the visitor.
void	iterateMessages(IMessageVisitor visitor)	This method should iterate over all the static messages and invoke the visitor for each message that should be added to the model.
void	iteratePortalMessages(IPortalMessageVisitor visitor)
void	iterateRoles(IRoleVisitor visitor)	This method should iterate over all the roles and add them to the visitor.
void	iterateServices(IServiceVisitor visitor)	This method should iterate over all the service definitions, and add them to the provided visitor.
void	iterateTeams(ITeamVisitor visitor)	This method should iterate over the various teams that are available in the application.
void	iterateThemes(IThemeVisitor visitor)	This method should iterate over all the themes that are available and add them to the visitor.
void	iterateValidators(IValidatorVisitor visitor)	This method should iterate over all the validator types and add them to the provided visitor.
void	iterateValueFormats(IValueFormatVisitor visitor)	This method should iterate over all the value formats, and invoke the visitor for each format that should be added to the model.

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectDS

public ProjectDS(IProjectDS datasource,
 IResourceManager resourceManager)

Constructs the project data-source with an existing data-source implementation that will be used as fall back.

Parameters:

datasource - Data source providing the information to initialize a project.

resourceManager - Resource manager for the current application.

Method Details

iterateMessages

public void iterateMessages(IMessageVisitor visitor)

Description copied from interface: IProjectDS

This method should iterate over all the static messages and invoke the visitor for each message that should be added to the model.

Specified by:

iterateMessages in interface IProjectDS

Parameters:

visitor - The visitor that should be used to add the messages to.

getDefaultLanguageName

public String getDefaultLanguageName()

Description copied from interface: IProjectDS

Returns the name of the default language, null when not specified.

Specified by:

getDefaultLanguageName in interface IProjectDS

Returns:

The name of the language that should be used as default.

getDefaultThemeName

public String getDefaultThemeName()

Description copied from interface: IProjectDS

Returns the name of the default theme, null when not specified.

Specified by:

getDefaultThemeName in interface IProjectDS

Returns:

The name of the theme that should be used as default.

getName

public String getName()

Description copied from interface: IProjectDS

This method returns the unique name of the application.

Specified by:

getName in interface IProjectDS

Returns:

The name of the application.

getVersion

public Version getVersion()

Description copied from interface: IProjectDS

This method returns the version of the application.

Specified by:

getVersion in interface IProjectDS

Returns:

The version of the application.

getApiTitle

public String getApiTitle()

Description copied from interface: IProjectDS

This method returns the api title.

Specified by:

getApiTitle in interface IProjectDS

Returns:

The api title.

getApiDocumentation

public String getApiDocumentation()

Description copied from interface: IProjectDS

This method returns the api documentation.

Specified by:

getApiDocumentation in interface IProjectDS

Returns:

The api documentation.

iterateChannels

public void iterateChannels(IChannelVisitor visitor)

Description copied from interface: IProjectDS

This method should iterate over the various channels that are available in the application. Components may use channels to restrict access to certain functionality. This method should return the super-set of all the channels that are used throughout the application.

Specified by:

iterateChannels in interface IProjectDS

Parameters:

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

iterateTeams

public void iterateTeams(ITeamVisitor visitor)

Description copied from interface: IProjectDS

This method should iterate over the various teams that are available in the application. Components may use teams to restrict access to certain functionality. This method should return the super-set of all the teams that are used throughout the application.

Specified by:

iterateTeams in interface IProjectDS

Parameters:

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

iterateLanguages

public void iterateLanguages(ILanguageVisitor visitor)

Description copied from interface: IProjectDS

This method should iterate over the available languages and add them to the visitor. At least one language should be provided.

Specified by:

iterateLanguages in interface IProjectDS

Parameters:

visitor - The visitor to which the languages should be added.

iterateRoles

public void iterateRoles(IRoleVisitor visitor)

Description copied from interface: IProjectDS

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

Specified by:

iterateRoles in interface IProjectDS

Parameters:

visitor - The visitor that should be used to add the role to.

iterateThemes

public void iterateThemes(IThemeVisitor visitor)

Description copied from interface: IProjectDS

This method should iterate over all the themes that are available and add them to the visitor.

Specified by:

iterateThemes in interface IProjectDS

Parameters:

visitor - The visitor that should be used to add the themes to.

iterateValueFormats

public void iterateValueFormats(IValueFormatVisitor visitor)

Description copied from interface: IProjectDS

This method should iterate over all the value formats, and invoke the visitor for each format that should be added to the model.

Specified by:

iterateValueFormats in interface IProjectDS

Parameters:

visitor - The visitor that should be used to add value formats to.

addMessage

public void addMessage(ErrorCode code,
 String[] parameters,
 Severity severity)

Description copied from interface: IReportingDS

This method will add an initialization error to the report for the specified error code and parameters.

Specified by:

addMessage in interface IReportingDS

Parameters:

code - Error code identifying the message.

parameters - Optional array of parameters for the message.

severity - The severity of the message.

iterateExpanders

public void iterateExpanders(IExpanderVisitor visitor)

Description copied from interface: IProjectDS

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

Specified by:

iterateExpanders in interface IProjectDS

Parameters:

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

iterateServices

public void iterateServices(IServiceVisitor visitor)

Description copied from interface: IProjectDS

This method should iterate over all the service definitions, and add them to the provided visitor.

Specified by:

iterateServices in interface IProjectDS

Parameters:

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

iterateValidators

public void iterateValidators(IValidatorVisitor visitor)

Description copied from interface: IProjectDS

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

Specified by:

iterateValidators in interface IProjectDS

Parameters:

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

iterateConnections

public void iterateConnections(IConnectionVisitor visitor)

Description copied from interface: IProjectDS

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

Specified by:

iterateConnections in interface IProjectDS

Parameters:

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

iteratePortalMessages

public void iteratePortalMessages(IPortalMessageVisitor visitor)

Specified by:

iteratePortalMessages in interface IProjectDS

iterateGlobalParameters

public void iterateGlobalParameters(IGlobalParameterVisitor visitor)

Specified by:

iterateGlobalParameters in interface IProjectDS

iterateFieldTypes

public void iterateFieldTypes(IFieldTypeVisitor visitor)

Specified by:

iterateFieldTypes in interface IProjectDS