Package com.aquima.interactions.metamodel.ds

Interface IInstanceDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ReportingInstanceDS, XmlInstanceDS, XmlInstanceDS
public interface IInstanceDS extends IReportingDS
This interface is used during initialization to add an instance definition to the meta model.
Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEntityName()
    This method should return the entity type of the instance that should be created.
    GUID
    getId()
    This method should return the unique id of the instance.
    String
    getInstanceName()
    Required field, the implementation should never return a null value here.
    void
    iterateValues(IValueVisitor visitor)
    The implementation of this method should call the appropriate method of the visitor for all the values that should be added to this instance.

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

    addMessage

  • Method Details

    • getId

      GUID getId()
      This method should return the unique id of the instance.
      Returns:
      String containing the id of the instance.

    • getEntityName

      String getEntityName()
      This method should return the entity type of the instance that should be created.
      Returns:
      The name of the entity for which the instance is defined.

    • getInstanceName

      String getInstanceName()
      Required field, the implementation should never return a null value here.
      Returns:
      The name of the instance.

    • iterateValues

      void iterateValues(IValueVisitor visitor)
      The implementation of this method should call the appropriate method of the visitor for all the values that should be added to this instance.
      Parameters:
      visitor - The visitor that should be used to add the values to.
      Throws:
      InitializationException - This error is thrown when the value could not be added.