Package com.aquima.interactions.metamodel.ds

Interface IEntityDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ReportingEntityDS, SystemEntity, UserEntity, XmlEntityDS, XmlEntityDS
public interface IEntityDS extends IReportingDS
This interface defines the methods that are needed to construct an entity definition object in the meta model.
Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    This method return the description for this entity.
    String
    getId()
    This method returns the unique identifier of the entity, consisting of the lowercased entity name.
    String
    getName()
    This method returns the unique name of the entity.
    String
    getSingletonName()
    This method may return the name that should be used when creating a singleton instance for this entity.
    String
    getSuperType()
    This method returns the name of the super type of the entity.
    boolean
    isAbstract()
    This method returns a boolean indicating if the entity definition is abstract, and may only used as super type of other entity definitions.
    boolean
    isSingleton()
    This method returns a boolean indicating if only a single instance of this type may exist at runtime.
    void
    iterateAttributes(IAttributeVisitor visitor)
    This method will be invoked by the meta model component to request the information of all attributes that are defined for this entity.

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

    addMessage

  • Method Details

    • getId

      String getId()
      This method returns the unique identifier of the entity, consisting of the lowercased entity name.
      Returns:
      the unique identifier of the entity.

    • getName

      String getName()
      This method returns the unique name of the entity.
      Returns:
      name of the entity

    • isSingleton

      boolean isSingleton()
      This method returns a boolean indicating if only a single instance of this type may exist at runtime.
      Returns:
      A boolean indicating whether only a single instance of this type may exist at runtime.

    • isAbstract

      boolean isAbstract()
      This method returns a boolean indicating if the entity definition is abstract, and may only used as super type of other entity definitions. Abstract entities can never be instantiated in the profile. If an entity is defined both abstract and singleton, the profile may hold multiple instances of this type, but each instance of an entity extending this abstract type must be a singleton.
      Returns:
      A boolean indicating if the entity definition is abstract.

    • getSingletonName

      String getSingletonName()
      This method may return the name that should be used when creating a singleton instance for this entity. The name of a singleton is only relevant when isSingleton method returns true.
      Returns:
      This method returns the name of the singleton instance.

    • getSuperType

      String getSuperType()
      This method returns the name of the super type of the entity. When the entity does not have any super type, the method should return a null value.
      Returns:
      name of the super type of this entity

    • iterateAttributes

      void iterateAttributes(IAttributeVisitor visitor)
      This method will be invoked by the meta model component to request the information of all attributes that are defined for this entity.
      Parameters:
      visitor - The visitor that should be used to add the attribute definitions to.
      Throws:
      InitializationException - This exception is thrown when there is an error processing the attributes.

    • getDescription

      String getDescription()
      This method return the description for this entity.
      Returns:
      Return the description for this entity