Package com.aquima.interactions.metamodel

Interface IAttributeDefinition

All Superinterfaces:
Serializable
All Known Implementing Classes:
AttributeDefinition
public interface IAttributeDefinition extends Serializable
This interface defines the methods that can be used to request static information about an attribute.
Since:
5.0
Author:
O. Kerpershoek, F. v.d. Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    DataType
    getDataType()
    This method returns the data type of the attribute.
    IDomainDefinition
    getDomain()
    This method returns the domain definition of the attribute.
    String
    getEntityName()
    This method returns the name of the entity that contains this attribute.
    String
    getFullName()
    This method return the full name of the attribute.
    String
    getFunctionalName()
    This method return the functional name of the attribute.
    String
    getId()
    This method returns the unique identifier of the attribute, consisting of the entity in which the attribute is defined plus the attribute name, lowercased, e.g.
    String
    getName()
    This method returns the name of the attribute.
    IReferenceDefinition
    getReferenceDefinition()
    Returns the reference definition of the attribute or null if this attribute is not a reference.
    IRelationDefinition
    getRelation()
    This method returns an object containing information about the relation.
    boolean
    isAskable()
    This method indicates whether the attribute can be answered by a client.
    boolean
    isMultiValue()
    This method indicates whether the attribute may contain multiple values.
    boolean
    isReference()
    Indicates that this attribute acts as a reference.

  • Method Details

    • getId

      String getId()
      This method returns the unique identifier of the attribute, consisting of the entity in which the attribute is defined plus the attribute name, lowercased, e.g. entity.attribute
      Returns:
      the unique identifier of the attribute.

    • getName

      String getName()
      This method returns the name of the attribute. The name of an attribute is unique within the entity where it is defined. For entities that have a super-type, the name will be unique within the complete entity structure. It is however possible that two entities that are not related contain an attribute with the same name.
      Returns:
      String containing the name of the attribute.

    • getEntityName

      String getEntityName()
      This method returns the name of the entity that contains this attribute.
      Returns:
      String containing the name of the entity that defines the attribute.

    • getFullName

      String getFullName()
      This method return the full name of the attribute. The full name consists of both the entity name and the attribute name separated with a dot.
      Returns:
      String with the full attribute name.

    • isMultiValue

      boolean isMultiValue()
      This method indicates whether the attribute may contain multiple values.
      Returns:
      boolean indicating whether the attribute may contain multiple values.

    • isAskable

      boolean isAskable()
      This method indicates whether the attribute can be answered by a client.
      Returns:
      boolean indicating whether the attribute can be answered by a client.

    • getDataType

      DataType getDataType()
      This method returns the data type of the attribute.
      Returns:
      DataType object indicating the type of the values for this attribute.

    • getRelation

      IRelationDefinition getRelation()
      This method returns an object containing information about the relation. The relation definition is only relevant for attributes of type Entity, as only those attributes can define a relation to another entity. For attributes that are not of the DataType Entity, this method will return a null value.
      Returns:
      IRelationDefinition containing information about the entity relation.

    • getDomain

      IDomainDefinition getDomain()
      This method returns the domain definition of the attribute. The value null will be returned for attributes that are not bound to any constraints. The returned domain is the static definition of the domain containing all possible values.
      Returns:
      Domain definition of the attribute, or null if not applicable.

    • getFunctionalName

      String getFunctionalName()
      This method return the functional name of the attribute.
      Returns:
      String with the functional attribute name.

    • isReference

      boolean isReference()
      Indicates that this attribute acts as a reference. If this method returns true, getReferenceDefinition() will return a non-null value.
      Returns:
      A boolean indicating that this attribute acts as a reference

    • getReferenceDefinition

      IReferenceDefinition getReferenceDefinition()
      Returns the reference definition of the attribute or null if this attribute is not a reference. Method isReference() should be used to check whether this attribute is a reference.
      Returns:
      The reference definition of the attribute