Class FieldMetaData

java.lang.Object
com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components.FieldMetaData
All Implemented Interfaces:
ToSchema
Direct Known Subclasses:
VirtualFieldMetaData
public class FieldMetaData extends Object implements ToSchema

  • Constructor Details

    • FieldMetaData

      public FieldMetaData(QFieldMetaData wrapped)
      Constructor

    • FieldMetaData

      public FieldMetaData(QFrontendFieldMetaData wrapped)
      Constructor

    • FieldMetaData

      public FieldMetaData()
      Constructor

  • Method Details

    • getName

      public String getName()

    • getLabel

      public String getLabel()

    • getType

      public String getType()

    • getIsRequired

      public Boolean getIsRequired()

    • getIsEditable

      public Boolean getIsEditable()

    • getIsHidden

      public Boolean getIsHidden()

    • getIsHeavy

      public Boolean getIsHeavy()

    • getDisplayFormat

      public String getDisplayFormat()

    • getDefaultValue

      public String getDefaultValue()

    • getPossibleValueSourceName

      public String getPossibleValueSourceName()

    • getPossibleValueSourceDependsOn

      public List<String> getPossibleValueSourceDependsOn()
      Other input fields that control this field's possible values.

    • getPossibleValueSourceDependencyBehavior

      public String getPossibleValueSourceDependencyBehavior()
      Behavior while any dependency is unset.

    • getPicker

      public QPossibleValuePicker getPicker()
      The record picker declared by this field's possible value source, if any.

    • getPickerTableName

      public String getPickerTableName()
      The table behind this field's picker (for its field labels and types).

    • getInlinePossibleValueSource

      public QPossibleValueSource getInlinePossibleValueSource()
      Inline possible values declared on a field, as in frontend metadata.

    • getMaxLength

      public Integer getMaxLength()

    • getMinValue

      public String getMinValue()
      The smallest value a field accepts, when its value range rejects smaller ones, so a form can say so before the user saves.

    • getMaxValue

      public String getMaxValue()
      The largest value a field accepts, when its value range rejects larger ones.

    • getGridColumns

      public Integer getGridColumns()
      Width of the field in a 12-column grid, as the Material dashboard lays out record forms and views (QRun-IO/qqq#723).

    • getBehaviors

      public List<String> getBehaviors()
      Names of the behaviors a frontend applies while a value is edited (e.g., TO_UPPER_CASE applied as the user types, QRun-IO/qqq#723), as the legacy table meta-data lists them.

    • getAdornments

      public List<FieldAdornment> getAdornments()

    • getHelpContents

      public List<HelpContentV1> getHelpContents()
      help content for the field (e.g., shown on view, edit and insert screens, per each entry's roles), as in the legacy table meta-data.

    • getSupplementalMetaData

      public Map<String,QSupplementalFieldMetaData> getSupplementalMetaData()
      Frontend-visible field settings, including Material form adjusters. Keep the same visibility filter as QFrontendFieldMetaData so backend-only supplemental metadata does not leak through the versioned API.

    • getAccessTier

      public FieldAccessTier getAccessTier()
      Effective tier; HIDDEN fields are omitted from table metadata.

    • getAllowedFilterOperators

      public List<String> getAllowedFilterOperators()
      Exact-match operators may also be disabled by the resolver.

    • getIsSortable

      public Boolean getIsSortable()
      Sorting is available only for FULL fields.