Class TableMetaData

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components.TableMetaDataLight

com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components.TableMetaData

All Implemented Interfaces:

ToSchema

public class TableMetaData
extends TableMetaDataLight
implements ToSchema

API response component for full table metadata, extending TableMetaDataLight with fields, sections, exposed joins, supplemental metadata, sharing configuration, and virtual fields.

Field Summary

Fields inherited from class com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components.TableMetaDataLight

wrapped

Constructor Summary

Constructors

Constructor	Description
TableMetaData()	Constructor
TableMetaData(QFrontendTableMetaData wrapped)	Constructor

Method Summary

Modifier and Type	Method	Description
List<Association>	getAssociations()
List<BuiltInViewV1>	getBuiltInViews()	Built-in session-relative views published by core.
List<ExposedJoin>	getExposedJoins()
Map<String,FieldMetaData>	getFields()
Boolean	getHasRestrictedFields()	Whether the current session has any restricted fields on this table.
List<TableMenu>	getMenus()
String	getPrimaryKeyField()
String	getQuickCreateSectionName()
List<RelatedRecordPicker>	getRelatedRecordPickers()
List<TableSection>	getSections()
ShareableTableMetaData	getShareableTableMetaData()
Map<String,QSupplementalTableMetaData>	getSupplementalMetaData()
Boolean	getUsesVariants()
Map<String,VirtualFieldMetaData>	getVirtualFields()

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components.TableMetaDataLight

getCapabilities, getDeletePermission, getEditPermission, getHelpContents, getIcon, getInsertPermission, getIsHidden, getLabel, getMetaDataGeneration, getName, getReadPermission, getRecordFeatures, getSearchFields, getVariantTableLabel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.kingsrook.qqq.middleware.javalin.schemabuilder.ToSchema

toSchema

Constructor Details

TableMetaData

public TableMetaData(QFrontendTableMetaData wrapped)

Constructor

TableMetaData

public TableMetaData()

Constructor

Method Details

getFields

public Map<String,FieldMetaData> getFields()

getPrimaryKeyField

public String getPrimaryKeyField()

getUsesVariants

public Boolean getUsesVariants()

getSections

public List<TableSection> getSections()

getExposedJoins

public List<ExposedJoin> getExposedJoins()

getAssociations

public List<Association> getAssociations()

getSupplementalMetaData

public Map<String,QSupplementalTableMetaData> getSupplementalMetaData()

getShareableTableMetaData

public ShareableTableMetaData getShareableTableMetaData()

getMenus

public List<TableMenu> getMenus()

getVirtualFields

public Map<String,VirtualFieldMetaData> getVirtualFields()

getRelatedRecordPickers

public List<RelatedRecordPicker> getRelatedRecordPickers()

getQuickCreateSectionName

public String getQuickCreateSectionName()

getBuiltInViews

public List<BuiltInViewV1> getBuiltInViews()

Built-in session-relative views published by core.

getHasRestrictedFields

public Boolean getHasRestrictedFields()

Whether the current session has any restricted fields on this table.