Package com.aquima.interactions.communication

Interface IDomainPropertyDefinition

All Known Implementing Classes:
CustomSchemaPropertyDefinition, DomainPropertyDefinition
public interface IDomainPropertyDefinition
Defines a property on a data object.
Since:
9.3
Author:
A.Pragt

  • Method Details Link icon

    • getName Link icon

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

    • getDocumentation Link icon

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

    • isRequired Link icon

      boolean isRequired()
      Returns an indicator whether the property is mandatory.
      Returns:
      Required indicator.

    • isNullable Link icon

      boolean isNullable()
      Returns an indicator whether the property is nullable.
      Returns:
      Nullable indicator.

    • isMultivalued Link icon

      boolean isMultivalued()
      Returns an indicator whether the property is multivalued.
      Returns:
      Multivalued indicator.

    • getAttributeName Link icon

      String getAttributeName()
      Returns the name of the attribute. The attribute must be a relation for an object definition. Also, it must match the datatype and the cardinality must match.
      Returns:
      The name of the attribute, may be null.

    • getItemName Link icon

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

    • getDataType Link icon

      DataType getDataType()
      Returns the data type of the property. When an Entity is the data object must be filled.
      Returns:
      The data type, may be null.

    • getObjectDefinition Link icon

      IDomainObjectDefinition getObjectDefinition()
      Returns the object definition.
      Returns:
      The object definition, mandatory in case of entity data type.

    • getSchemaName Link icon

      String getSchemaName()
      Returns the schemaName
      Returns:
      The domain schema name.

    • getValidations Link icon

      IFieldValidationDefinition[] getValidations()
      This method returns the validations of the attribute.
      Returns:
      The validations of the attribute, may not be null.

    • getAttributeRelationEntityName Link icon

      String getAttributeRelationEntityName()
      This method returns the name of entity where the domain property has a relation to. This method only returns a value when the domain property refers to a relation.
      Returns:
      The name of entity where the domain property has a relation to, can be null.

    • getCustomSchemaElement Link icon

      IElementReference getCustomSchemaElement()
      Returns the custom schema element.
      Returns:
      The custom schema element, otherwise null.