Package com.aquima.interactions.project

Interface IFieldTypeDefinition

All Superinterfaces:
Serializable
All Known Implementing Classes:
FieldTypeDefinition
public interface IFieldTypeDefinition extends Serializable
Describes the definition of a Field Type
Since:
11.1
Author:
Mihai Bob

  • Method Summary

    Modifier and Type
    Method
    Description
    DataType
    getDataType()
    Based on the output type, this will return the data type inside the field type
    String
    getName()
    Returns the unique name of the field type.
    FieldTypeOutput
    getOutput()
    Returns the output of this Field Type
    boolean
    isLengthAvailable()
    Specifies whether the option to set the field's length property is available
    boolean
    isPreconditionAvailable()
    Specifies whether the option to set the field's precondition property is available
    boolean
    isReadOnlyAvailable()
    Specifies whether the option to set the field's read only property is available
    boolean
    isRefreshAvailable()
    Specifies whether the option to set the field's refresh property is available
    boolean
    isRequiredAvailable()
    Specifies whether the option to set the field's required property is available

  • Method Details

    • getName

      String getName()
      Returns the unique name of the field type. May not be null.
      Returns:
      the name of the field type

    • getOutput

      FieldTypeOutput getOutput()
      Returns the output of this Field Type
      Returns:
      the output of this Field Type

    • getDataType

      DataType getDataType()
      Based on the output type, this will return the data type inside the field type
      Returns:
      DataType

    • isPreconditionAvailable

      boolean isPreconditionAvailable()
      Specifies whether the option to set the field's precondition property is available
      Returns:
      whether the option to set the field's precondition property is available

    • isReadOnlyAvailable

      boolean isReadOnlyAvailable()
      Specifies whether the option to set the field's read only property is available
      Returns:
      true if available otherwise false

    • isRequiredAvailable

      boolean isRequiredAvailable()
      Specifies whether the option to set the field's required property is available
      Returns:
      true if available otherwise false

    • isRefreshAvailable

      boolean isRefreshAvailable()
      Specifies whether the option to set the field's refresh property is available
      Returns:
      true if available otherwise false

    • isLengthAvailable

      boolean isLengthAvailable()
      Specifies whether the option to set the field's length property is available
      Returns:
      true if available otherwise false