Package com.aquima.interactions.metamodel.ds

Interface IDomainDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
DomainDelegateDS, DomainDS, ReportingDomainDS, XmlDomainDS, XmlDomainDS
public interface IDomainDS extends IReportingDS
This interface defines the methods that are needed to initialize a domain definition.
Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    allowEmptyDomain()
    This method specifies if the domain should allow the datasource to return an empty set of domain values.
    DataType
    getDataType()
    The data type of the domain.
    String
    getDescription()
    This method returns the (optional) description of the domain.
    String
    getName()
    This method should return the unique name of the domain.
    boolean
    isExternalDomain()
    This method returns a boolean indicating if the values for the domain will be provided by an external source.
    void
    iterateValues(IDomainValueVisitor visitor)
    This method should iterate over all values that are valid in the domain, and invoke the visitor for each one of them.

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

    addMessage

  • Method Details

    • getName

      String getName()
      This method should return the unique name of the domain.
      Returns:
      String containing the name of the domain.

    • getDataType

      DataType getDataType()
      The data type of the domain. The domain can only be active for attributes that share the same type, and all values of this domain will need to be of the same data type.
      Returns:
      The type of the values of this domain.

    • getDescription

      String getDescription()
      This method returns the (optional) description of the domain.
      Returns:
      Description of the domain. (only used for informational purposes)

    • allowEmptyDomain

      boolean allowEmptyDomain()
      This method specifies if the domain should allow the datasource to return an empty set of domain values. By default this method should return false, as a domain without any valid values will not allow any value for the attributes the domain is assigned to. During development this method may however return the value true to indicate that an empty domain is allowed. When an empty domain is encountered and this method returns true for that domain, a warning will be generated indicating that the domain should be fixed.
      Returns:
      Boolean indicating if an empty domain is allowed.

    • isExternalDomain

      boolean isExternalDomain()
      This method returns a boolean indicating if the values for the domain will be provided by an external source. The boolean is used mainly for validation purposes, as an external domain will not have any values during definition in studio.
      Returns:
      a boolean indicating if the values for the domain will be provided by an external source.

    • iterateValues

      void iterateValues(IDomainValueVisitor visitor)
      This method should iterate over all values that are valid in the domain, and invoke the visitor for each one of them.
      Parameters:
      visitor - The visitor that the domain values should be added to.
      Throws:
      InitializationException - Thrown when there was an error while processing the domain values.