Class QFrontendFieldMetaData

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.frontend.QFrontendFieldMetaData
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
QFrontendVirtualFieldMetaData
public class QFrontendFieldMetaData extends Object implements Serializable
Version of QFieldMetaData that's meant for transmitting to a frontend. e.g., it excludes backend-only details.
See Also:

  • Constructor Details

    • QFrontendFieldMetaData

      public QFrontendFieldMetaData(QFieldMetaData fieldMetaData)
      Constructor

    • QFrontendFieldMetaData

      public QFrontendFieldMetaData(QFieldMetaData fieldMetaData, FieldAccessTier tier)
      Construct session-specific field capabilities.

    • QFrontendFieldMetaData

      public QFrontendFieldMetaData(QFieldMetaData fieldMetaData, FieldAccessDecision decision)
      Construct session-specific capabilities including exact-match restrictions.

  • Method Details

    • getName

      public String getName()
      Getter for name

    • getLabel

      public String getLabel()
      Getter for label

    • getType

      public QFieldType getType()
      Getter for type

    • getIsRequired

      public boolean getIsRequired()
      Getter for isRequired

    • getIsEditable

      public boolean getIsEditable()
      Getter for isEditable

    • getIsHeavy

      public boolean getIsHeavy()
      Getter for isHeavy

    • getIsSensitive

      public boolean getIsSensitive()
      Getter for isSensitive - frontends may use it to mask values by default.

    • getIsHidden

      public boolean getIsHidden()
      Getter for isHidden

    • getGridColumns

      public Integer getGridColumns()
      Getter for gridColumns

    • getDisplayFormat

      public String getDisplayFormat()
      Getter for displayFormat

    • getAdornments

      public List<FieldAdornment> getAdornments()
      Getter for adornments

    • getPossibleValueSourceName

      public String getPossibleValueSourceName()
      Getter for possibleValueSourceName

    • getDefaultValue

      public Serializable getDefaultValue()
      Getter for defaultValue

    • getHelpContents

      public List<QHelpContent> getHelpContents()
      Getter for helpContents

    • getInlinePossibleValueSource

      public QPossibleValueSource getInlinePossibleValueSource()
      Getter for inlinePossibleValueSource

    • getBehaviors

      public List<FieldBehaviorForFrontend> getBehaviors()
      Getter for fieldBehaviors

    • getSupplementalFieldMetaData

      public Map<String,QSupplementalFieldMetaData> getSupplementalFieldMetaData()
      Getter for supplementalFieldMetaData

    • getMaxLength

      public Integer getMaxLength()
      Getter for maxLength

    • getMinValue

      public Number getMinValue()
      Getter for minValue - the smallest value accepted, when the field's ValueRangeBehavior rejects smaller ones.

    • getMaxValue

      public Number getMaxValue()
      Getter for maxValue - the largest value accepted, when the field's ValueRangeBehavior rejects larger ones.

    • getPossibleValueSourceFilter

      public QQueryFilter getPossibleValueSourceFilter()
      Getter for possibleValueSourceFilter

    • getPicker

      public QPossibleValuePicker getPicker()
      Getter for picker

    • getPickerTableName

      public String getPickerTableName()
      Getter for pickerTableName

    • getAccessTier

      public String getAccessTier()
      Getter for accessTier

    • getAllowedFilterOperators

      public List<String> getAllowedFilterOperators()
      Getter for allowedFilterOperators

    • getIsSortable

      public Boolean getIsSortable()
      Getter for isSortable

    • getPossibleValueSourceDependsOn

      public List<String> getPossibleValueSourceDependsOn()
      Getter for possibleValueSourceDependsOn

    • getPossibleValueSourceDependencyBehavior

      public String getPossibleValueSourceDependencyBehavior()
      Getter for possibleValueSourceDependencyBehavior