Package com.aquima.interactions.metamodel.ds

Interface IAttributeDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
CaseId, Channel, CurrentPage, Event, Language, PageValid, Roles, TaskId, Teams, Tenant, Today, User, UserId, UserName, XmlAttributeDS, XmlAttributeDS
public interface IAttributeDS extends IReportingDS
This interface is used to load most, if not all, the information of an attribute.

Copyright: Copyright (c) 2001

Company: Everest b.v.

Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    DataType
    getDataType()
    This method returns the data type of the attribute.
    String
    getDescription()
    This method return the description for this attribute.
    String
    getDomainName()
    This method returns the name of the domain for the attribute.
    String
    getFunctionalName()
    This method return the functional name for this 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.
    IReferenceDS
    getReference()
    This method returns the reference of the attribute
    IRelationDS
    getRelation()
    This method returns an object containing information about the relation.
    boolean
    isAskable()
    This method returns a boolean indicating if the attribute value can be provided by the client.
    boolean
    isMultiValue()
    This method returns whether the profile contains (or may contain) multiple values for this attribute.
    boolean
    isReference()
    This method returns a boolean indicating that this attribute acts as a reference
    boolean
    isReverseAttribute()
    This method returns a boolean indicating this attribute is a reverse relation attribute.

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

    addMessage

  • 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.
      Returns:
      The name of the attribute.

    • getDataType

      DataType getDataType()
      This method returns the data type of the attribute.
      Returns:
      The data type of the attribute.

    • getDomainName

      String getDomainName()
      This method returns the name of the domain for the attribute. The domain name may be empty null when the attribute has no domain.
      Returns:
      The id of the domain the values are restricted to.

    • isAskable

      boolean isAskable()
      This method returns a boolean indicating if the attribute value can be provided by the client.
      Returns:
      boolean indicating if the client is able to provide a value for this attribute.

    • getRelation

      IRelationDS getRelation()
      This method returns an object containing information about the relation. The relation information is only relevant for the data type Entity, and should return null for attributes of other data types.
      Returns:
      data source containing information about the relation.

    • isMultiValue

      boolean isMultiValue()
      This method returns whether the profile contains (or may contain) multiple values for this attribute. Attributes that can have multiple values in the profile should also define a multi-value strategy.
      Returns:
      boolean indicating whether the profile can contain multiple values for this attribute.

    • isReverseAttribute

      boolean isReverseAttribute()
      This method returns a boolean indicating this attribute is a reverse relation attribute.
      Returns:
      A boolean indicating this attribute is a reverse relation attribute.

    • getDescription

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

    • getFunctionalName

      String getFunctionalName()
      This method return the functional name for this attribute.
      Returns:
      Return the functional name for this attribute

    • isReference

      boolean isReference()
      This method returns a boolean indicating that this attribute acts as a reference
      Returns:
      A boolean indicating that this attribute acts as a reference

    • getReference

      IReferenceDS getReference()
      This method returns the reference of the attribute
      Returns:
      The reference type of the attribute