Package com.aquima.interactions.communication.ds

Interface IDomainPropertyDS

All Known Implementing Classes:
ReportingDomainPropertyDS, XmlDomainPropertyDS, XmlDomainPropertyDS
public interface IDomainPropertyDS
Datasource for a property.
Since:
9.3
Author:
A.Pragt

  • Method Details

    • getName

      String getName()
      Returns the name of the property.
      Returns:
      The name, never null.

    • getDocumentation

      String getDocumentation()
      Returns the documentation of the property.
      Returns:
      The documentation, may be null

    • isRequired

      boolean isRequired()
      Returns the required indicator.
      Returns:
      The indicator.

    • isMultivalued

      boolean isMultivalued()
      Returns the multivalued indicator.
      Returns:
      The indicator.

    • getItemName

      String getItemName()
      Returns the optional name of the items within this property.
      Returns:
      The optional item name, may be null.

    • getAttributeName

      String getAttributeName()
      Returns the name of the attribute.
      Returns:
      The name of the attribute, never null.

    • getDataType

      DataType getDataType()
      Returns the datatype of the property.
      Returns:
      The data type, never null.

    • getObjectDefinition

      IDomainObjectDS getObjectDefinition()
      Returns the data object.
      Returns:
      The data object in case of an entity data type, otherwise null.

    • getSchemaName

      String getSchemaName()
      Returns the domain schema name.
      Returns:
      The name of the domain schema in case of an domain schema entry, otherwise null.

    • iterateValidations

      void iterateValidations(IFieldValidationVisitor visitor)
      This method iterates about the validations of the particle attribute.
      Parameters:
      visitor - The visitor accepting the validations, not null.
      Throws:
      InitializationException - This exception is thrown when the validation could not be initialized with the provided data source.

    • getCustomSchemaElementRef

      IElementReferenceDS getCustomSchemaElementRef()
      Returns the custom schema element datasource.
      Returns:
      The custom schema element datasource, otherwise null.