Package com.aquima.interactions.metamodel.ds

Interface IAggregateDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
XmlAggregateDS, XmlAggregateDS
public interface IAggregateDS extends IReportingDS
Interface for an aggregate data source.
Author:
voicu

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFunctionalName()
    This method should return the functional name of the aggregate.
    String
    getName()
    This method should return the name of the aggregate.
    String[]
    getRoles()
    This method returns the aggregate's roles.
    void
    iterateEntityReferences(IEntityReferenceVisitor visitor)
    This method should iterate over all entity references that are valid in the aggregate definition and invoke the visitor for each one of them.
    void
    iterateMetadata(IMetadataVisitor visitor)
    This method iterates over the metadata data sources in this aggregate data source and invokes he given visitor's process method for each one.

    Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

    addMessage

  • Method Details

    • getName

      String getName()
      This method should return the name of the aggregate.
      Returns:
      (String) The name of the aggregate.

    • getFunctionalName

      String getFunctionalName()
      This method should return the functional name of the aggregate.
      Returns:
      (String) THe functional name of the aggregate.

    • iterateEntityReferences

      void iterateEntityReferences(IEntityReferenceVisitor visitor)
      This method should iterate over all entity references that are valid in the aggregate definition and invoke the visitor for each one of them.
      Parameters:
      visitor - The visitor that the entity references should be added to.
      Throws:
      InitializationException - Thrown when there was an error while processing the entity references.

    • iterateMetadata

      void iterateMetadata(IMetadataVisitor visitor)
      This method iterates over the metadata data sources in this aggregate data source and invokes he given visitor's process method for each one.
      Parameters:
      visitor - The visitor that the metadata reference should be added to.
      Throws:
      InitializationException - Thrown when there was an error while processing the entity references.

    • getRoles

      String[] getRoles()
      This method returns the aggregate's roles. If no roles exists, it will return an empty array.
      Returns:
      The roles of the aggregate