Package com.aquima.interactions.metamodel.ds

Interface IEntityReferenceDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
XmlEntityReferenceDS, XmlEntityReferenceDS
public interface IEntityReferenceDS extends IReportingDS
This interface defines the methods that are needed to construct an entity reference object in the aggregate definition.

Note: for backward compatibility reasons, an entity reference datasource contains excluded relations, while an entity reference contains included relations. The translation is done automatically when an entity reference is constructed from an entity reference datasource.

Author:
voicu

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEntityName()
    This method returns the name of the referred entity definition.
    boolean
    isRootEntity()
    Indicates whether the entity reference is a root in an aggregate.
    void
    iterateExcludedRelations(IAttributeReferenceVisitor visitor)
    Iterates over all relations excluded from the entity reference and invoke the visitor for each one.

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

    addMessage

  • Method Details

    • getEntityName

      String getEntityName()
      This method returns the name of the referred entity definition.
      Returns:
      The entity name.

    • isRootEntity

      boolean isRootEntity()
      Indicates whether the entity reference is a root in an aggregate. An entity reference is a root entity if it is explicitly included in the aggregate.
      Returns:
      true if the referred entity is a root entity in the aggregate, false otherwise.

    • iterateExcludedRelations

      void iterateExcludedRelations(IAttributeReferenceVisitor visitor)
      Iterates over all relations excluded from the entity reference and invoke the visitor for each one.
      Parameters:
      visitor - the visitor which should be invoked for each excluded relation
      Throws:
      InitializationException - if there is an error processing a relation