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

  • 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) throws InitializationException
      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.
      Throws:
      InitializationException - This error is thrown when an error is encountered during the processing of the messages.

    • 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.

    • getDescription

      public String getDescription()
      Description copied from interface: IProjectDS
      This method returns the description of the application.
      Specified by:
      getDescription in interface IProjectDS
      Returns:
      The description of the application.

    • 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.

    • iterateChannels

      public void iterateChannels(IChannelVisitor visitor) throws InitializationException
      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.
      Throws:
      InitializationException - This exception is thrown when an invalid channel definition is added.

    • iterateTeams

      public void iterateTeams(ITeamVisitor visitor) throws InitializationException
      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.
      Throws:
      InitializationException - This exception is thrown when an invalid team definition is added.

    • iterateLanguages

      public void iterateLanguages(ILanguageVisitor visitor) throws InitializationException
      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.
      Throws:
      InitializationException - This exception is thrown when invalid language data is provided.

    • iterateRoles

      public void iterateRoles(IRoleVisitor visitor) throws InitializationException
      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.
      Throws:
      InitializationException - This exception is thrown when the role could not be initialized.

    • iterateThemes

      public void iterateThemes(IThemeVisitor visitor) throws InitializationException
      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.
      Throws:
      InitializationException - this exception is thrown when an invalid theme definition is added.

    • iterateValueFormats

      public void iterateValueFormats(IValueFormatVisitor visitor) throws InitializationException
      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.
      Throws:
      InitializationException - this exception is thrown when an error is encountered during the processing of the value formats.

    • 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) throws InitializationException
      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.
      Throws:
      InitializationException - This exception is thrown when the expander definitions could not be initialized.

    • iterateServices

      public void iterateServices(IServiceVisitor visitor) throws InitializationException
      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.
      Throws:
      InitializationException - This exception is thrown when the service definitions could not be initialized.

    • iterateValidators

      public void iterateValidators(IValidatorVisitor visitor) throws InitializationException
      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.
      Throws:
      InitializationException - This exception is thrown when the validator type definitions could not be initialized.

    • iterateConnections

      public void iterateConnections(IConnectionVisitor visitor) throws InitializationException
      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.
      Throws:
      InitializationException - This exception is thrown when the data connections could not be initialized.

    • iteratePortalMessages

      public void iteratePortalMessages(IPortalMessageVisitor visitor) throws InitializationException
      Specified by:
      iteratePortalMessages in interface IProjectDS
      Throws:
      InitializationException

    • iterateGlobalParameters

      public void iterateGlobalParameters(IGlobalParameterVisitor visitor) throws InitializationException
      Specified by:
      iterateGlobalParameters in interface IProjectDS
      Throws:
      InitializationException

    • iterateFieldTypes

      public void iterateFieldTypes(IFieldTypeVisitor visitor) throws InitializationException
      Specified by:
      iterateFieldTypes in interface IProjectDS
      Throws:
      InitializationException