Class QFrontendRelatedRecordPicker

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.frontend.QFrontendRelatedRecordPicker
public class QFrontendRelatedRecordPicker extends Object
A related-record picker as published to frontends: the metadata with its tables resolved, defaults applied, and what this user may do with it.

  • Constructor Details

  • Method Details

    • getName

      public String getName()
      The picker's name (the path segment of its v1 routes).

    • getLabel

      public String getLabel()
      The dialog title and the child-list button label.

    • getMode

      public String getMode()
      SINGLE, MULTI_CHILD or LINK.

    • getFieldName

      public String getFieldName()
      The foreign-key field (SINGLE).

    • getAssociationName

      public String getAssociationName()
      The association (MULTI_CHILD, LINK).

    • getTargetTableName

      public String getTargetTableName()
      The table records are picked from.

    • getChildTableName

      public String getChildTableName()
      The child or join table (MULTI_CHILD, LINK).

    • getChildTargetFieldName

      public String getChildTargetFieldName()
      The child table's field holding the target key (MULTI_CHILD, LINK).

    • getFilter

      public QQueryFilter getFilter()
      The filter always applied by the server (may hold ${input.x} variables).

    • getDefaultFilter

      public QQueryFilter getDefaultFilter()
      The initial, user-editable filter (may hold ${input.x} variables; the query route returns it resolved).

    • getColumns

      public List<String> getColumns()
      The result columns.

    • getPreviewFields

      public List<String> getPreviewFields()
      The preview fields.

    • getThumbnailField

      public String getThumbnailField()
      An image URL field of the target, for thumbnails.

    • getReviewFieldNames

      public List<String> getReviewFieldNames()
      The child fields of the review step (MULTI_CHILD; empty skips it).

    • getMaxSelections

      public Integer getMaxSelections()
      The most records one confirm may pick (MULTI_CHILD, LINK).

    • getCanCreateTarget

      public boolean getCanCreateTarget()
      Whether this user may quick-create a target record.

    • getCanAddChildren

      public boolean getCanAddChildren()
      Whether this user may add child or join rows.

    • getCanRemoveChildren

      public boolean getCanRemoveChildren()
      Whether this user may remove links (LINK).