Class QFrontendTableMetaData

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.frontend.QFrontendTableMetaData
public class QFrontendTableMetaData extends Object
Version of QTableMetaData that's meant for transmitting to a frontend. e.g., it excludes backend-only details.

  • Constructor Details

    • QFrontendTableMetaData

      public QFrontendTableMetaData(AbstractActionInput actionInput, QBackendMetaData backendForTable, QTableMetaData tableMetaData, boolean includeFullMetaData, boolean includeJoins)
      standard constructor - uses all fields on the table.

    • QFrontendTableMetaData

      public QFrontendTableMetaData(AbstractActionInput actionInput, QBackendMetaData backendForTable, QTableMetaData tableMetaData, boolean includeFullMetaData, boolean includeJoins, Map<String,QFieldMetaData> overrideFields)
      alternative constructor - takes a map of fields to use (e.g., for an old api version of the table w/ different fields!)

  • Method Details

    • getRelatedRecordPickers

      public List<QFrontendRelatedRecordPicker> getRelatedRecordPickers()
      Getter for relatedRecordPickers

    • getQuickCreateSectionName

      public String getQuickCreateSectionName()
      Getter for quickCreateSectionName

    • withoutCapability

      public QFrontendTableMetaData withoutCapability(Capability capability)
      Alternative fluent setter for a single disabledCapabilities

    • getName

      public String getName()
      Getter for name

    • getLabel

      public String getLabel()
      Getter for label

    • getPrimaryKeyField

      public String getPrimaryKeyField()
      Getter for primaryKeyField

    • getFields

      public Map<String,QFrontendFieldMetaData> getFields()
      Getter for fields

    • getSections

      public List<QFieldSection> getSections()
      Getter for sections

    • getIsHidden

      public boolean getIsHidden()
      Getter for isHidden

    • getIconName

      public String getIconName()
      Getter for iconName

    • getCapabilities

      public Set<String> getCapabilities()
      Getter for capabilities

    • getReadPermission

      public boolean getReadPermission()
      Getter for readPermission

    • getInsertPermission

      public boolean getInsertPermission()
      Getter for insertPermission

    • getEditPermission

      public boolean getEditPermission()
      Getter for editPermission

    • getDeletePermission

      public boolean getDeletePermission()
      Getter for deletePermission

    • getUsesVariants

      public boolean getUsesVariants()
      Getter for usesVariants

    • getExposedJoins

      public List<QFrontendExposedJoin> getExposedJoins()
      Getter for exposedJoins

    • getSupplementalTableMetaData

      public Map<String,QSupplementalTableMetaData> getSupplementalTableMetaData()
      Getter for supplementalTableMetaData

    • getVariantTableLabel

      public String getVariantTableLabel()
      Getter for variantTableLabel

    • getShareableTableMetaData

      public ShareableTableMetaData getShareableTableMetaData()
      Getter for shareableTableMetaData

    • getHelpContents

      public Map<String,List<QHelpContent>> getHelpContents()
      Getter for helpContents

    • getIcon

      public QIcon getIcon()
      Getter for icon

    • getVirtualFields

      public Map<String,QFrontendVirtualFieldMetaData> getVirtualFields()
      Getter for virtualFields

    • getMenus

      public List<QMenu> getMenus()
      Getter for menus

    • getAssociations

      public List<QFrontendAssociation> getAssociations()
      Getter for associations

    • getSearchFields

      public List<String> getSearchFields()
      Getter for searchFields - names of the fields record search matches for this table (null when the table is not searchable by this session).

    • getRecordFeatures

      public FrontendRecordFeatures getRecordFeatures()
      Getter for recordFeatures

    • setRecordFeatures

      public void setRecordFeatures(FrontendRecordFeatures recordFeatures)
      Setter for recordFeatures

    • withRecordFeatures

      public QFrontendTableMetaData withRecordFeatures(FrontendRecordFeatures recordFeatures)
      Fluent setter for recordFeatures

    • getMetaDataGeneration

      public Long getMetaDataGeneration()
      Getter for metaDataGeneration

    • setMetaDataGeneration

      public void setMetaDataGeneration(Long metaDataGeneration)
      Setter for metaDataGeneration

    • withMetaDataGeneration

      public QFrontendTableMetaData withMetaDataGeneration(Long metaDataGeneration)
      Fluent setter for metaDataGeneration

    • getBuiltInViews

      public List<QFrontendBuiltInView> getBuiltInViews()
      Views supplied by core; not persisted as user-owned saved views.

    • getHasRestrictedFields

      public boolean getHasRestrictedFields()
      Whether this session has any restricted fields, including omitted fields.