Class ProjectDS
java.lang.Object
com.aquima.interactions.portal.ds.sys.project.ProjectDS
- All Implemented Interfaces:
IReportingDS
,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
ConstructorsConstructorDescriptionProjectDS
(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 TypeMethodDescriptionvoid
addMessage
(ErrorCode code, String[] parameters, Severity severity) This method will add an initialization error to the report for the specified error code and parameters.This method returns the api documentation.This method returns the api title.Returns the name of the default language, null when not specified.Returns the name of the default theme, null when not specified.getName()
This method returns the unique name of the application.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
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
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.
-
Constructor Details
-
Method Details
-
iterateMessages
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 interfaceIProjectDS
- Parameters:
visitor
- The visitor that should be used to add the messages to.
-
getDefaultLanguageName
Description copied from interface:IProjectDS
Returns the name of the default language, null when not specified.- Specified by:
getDefaultLanguageName
in interfaceIProjectDS
- Returns:
- The name of the language that should be used as default.
-
getDefaultThemeName
Description copied from interface:IProjectDS
Returns the name of the default theme, null when not specified.- Specified by:
getDefaultThemeName
in interfaceIProjectDS
- Returns:
- The name of the theme that should be used as default.
-
getName
Description copied from interface:IProjectDS
This method returns the unique name of the application.- Specified by:
getName
in interfaceIProjectDS
- Returns:
- The name of the application.
-
getVersion
Description copied from interface:IProjectDS
This method returns the version of the application.- Specified by:
getVersion
in interfaceIProjectDS
- Returns:
- The version of the application.
-
getApiTitle
Description copied from interface:IProjectDS
This method returns the api title.- Specified by:
getApiTitle
in interfaceIProjectDS
- Returns:
- The api title.
-
getApiDocumentation
Description copied from interface:IProjectDS
This method returns the api documentation.- Specified by:
getApiDocumentation
in interfaceIProjectDS
- Returns:
- The api documentation.
-
iterateChannels
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 interfaceIProjectDS
- Parameters:
visitor
- The visitor that should be used to add the channel definitions to.
-
iterateTeams
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 interfaceIProjectDS
- Parameters:
visitor
- The visitor that should be used to add the team definitions to.
-
iterateLanguages
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 interfaceIProjectDS
- Parameters:
visitor
- The visitor to which the languages should be added.
-
iterateRoles
Description copied from interface:IProjectDS
This method should iterate over all the roles and add them to the visitor.- Specified by:
iterateRoles
in interfaceIProjectDS
- Parameters:
visitor
- The visitor that should be used to add the role to.
-
iterateThemes
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 interfaceIProjectDS
- Parameters:
visitor
- The visitor that should be used to add the themes to.
-
iterateValueFormats
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 interfaceIProjectDS
- Parameters:
visitor
- The visitor that should be used to add value formats to.
-
addMessage
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 interfaceIReportingDS
- Parameters:
code
- Error code identifying the message.parameters
- Optional array of parameters for the message.severity
- The severity of the message.
-
iterateExpanders
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 interfaceIProjectDS
- Parameters:
visitor
- The visitor that should be used to add the expander definitions to.
-
iterateServices
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 interfaceIProjectDS
- Parameters:
visitor
- The visitor that should be used to add the service definitions to.
-
iterateValidators
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 interfaceIProjectDS
- Parameters:
visitor
- The visitor that should be used to add the validator type definitions to.
-
iterateConnections
Description copied from interface:IProjectDS
This method should iterate over all the connections and add them to the provided visitor.- Specified by:
iterateConnections
in interfaceIProjectDS
- Parameters:
visitor
- The visitor that should be used to add the connections definitions to.
-
iteratePortalMessages
- Specified by:
iteratePortalMessages
in interfaceIProjectDS
-
iterateGlobalParameters
- Specified by:
iterateGlobalParameters
in interfaceIProjectDS
-
iterateFieldTypes
- Specified by:
iterateFieldTypes
in interfaceIProjectDS
-