Package com.aquima.interactions.metamodel.ds

Interface IRelationDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
XmlRelationDS, XmlRelationDS
public interface IRelationDS extends IReportingDS
This interface provides the information to initialize a relation definition.
Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAttributeName()
    The related entity attribute is only requested for attributes with the data-type entity.
    String
    getEntityName()
    The entity is only requested for attributes with the data-type entity.
    IMultilingualText
    getExplainText()
    This method returns the explain text of the relation.
    IMultilingualText
    getQuestionText()
    This method returns the question text of the relation.
    RelationType
    getType()
    This method returns the type of the relation.
    boolean
    referrerIsOwner()
    This method returns a boolean indicating if the attribute to which this relation belongs is the owner of the instance referred.

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

    addMessage

  • Method Details

    • getType

      RelationType getType()
      This method returns the type of the relation.
      Returns:
      The type of the relation.

    • referrerIsOwner

      boolean referrerIsOwner()
      This method returns a boolean indicating if the attribute to which this relation belongs is the owner of the instance referred.
      Returns:
      boolean indicating if the attribute to which this relation belongs is the owner of the instance referred.

    • getEntityName

      String getEntityName()
      The entity is only requested for attributes with the data-type entity. This method will not be invoked with any other type.
      Returns:
      The name of the entity this attribute represents.

    • getAttributeName

      String getAttributeName()
      The related entity attribute is only requested for attributes with the data-type entity. This method will not be invoked with any other type.
      Returns:
      The name of the attribute that forms a two-way-relation with this entity attribute.

    • getQuestionText

      IMultilingualText getQuestionText()
      This method returns the question text of the relation.
      Returns:
      An IMultilingualText containing the relation question text.

    • getExplainText

      IMultilingualText getExplainText()
      This method returns the explain text of the relation.
      Returns:
      An IMultilingualText containing the relation explain text.