Package com.onenetwork.platform.common.field

Interface Field

public interface Field
Captures field meta-data including id, type, etc.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDescription()
    Optional description of the field
    FieldId getId()
    Unique identifier for the field
    FieldType getType()
    Identifies the field's data type
    boolean isHidden()
    Returns true if this is a hidden field, false otherwise
    boolean isOptional()
    Returns true if this is an optional field, false otherwise
    void setDescription​(java.lang.String description)
    Sets the optional description of the field
    void setHidden​(boolean isHidden)
    Sets the hidden flag on the field
    void setId​(FieldId fieldId)
    Sets the unique identifier for the field
    void setOptional​(boolean isOptional)
    Sets the optional flag on the field
    void setType​(FieldType type)
    Sets the field's data type

  • Method Details

    • getId

      FieldId getId()
      Unique identifier for the field

    • setId

      void setId​(FieldId fieldId)
      Sets the unique identifier for the field

    • getType

      FieldType getType()
      Identifies the field's data type

    • setType

      void setType​(FieldType type)
      Sets the field's data type

    • getDescription

      java.lang.String getDescription()
      Optional description of the field

    • setDescription

      void setDescription​(java.lang.String description)
      Sets the optional description of the field

    • isOptional

      boolean isOptional()
      Returns true if this is an optional field, false otherwise

    • isHidden

      boolean isHidden()
      Returns true if this is a hidden field, false otherwise

    • setHidden

      void setHidden​(boolean isHidden)
      Sets the hidden flag on the field

    • setOptional

      void setOptional​(boolean isOptional)
      Sets the optional flag on the field