Class QPossibleValuePicker

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValuePicker
All Implemented Interfaces:
Serializable
public class QPossibleValuePicker extends Object implements Serializable
Declares that a table-type possible value source is chosen with a record picker (a searchable, filterable, paged dialog) rather than only an inline dropdown - for sources over tables that grow large (e.g., 100,000+ media). Every field that uses the source gets the picker. The fields named here are the only ones the possible-values API will filter or sort on, or return per option, for a picker request: a picker never exposes other columns of the source table. - thumbnailField: an image URL shown for each option (and the selection). - previewField: a larger image URL for the preview pane (else thumbnail). - subtitleFields: short secondary text under each option label. - detailFields: shown in the preview pane (e.g., dimensions, size, alt). - filterFields: offered as filters; their types/PVSes drive the controls. - searchFields: matched with CONTAINS (default: the source searchFields). - sorts: the offered orderings; the first is the default. A sort on the primary key alone is paged by keyset (no OFFSET, no count). - pageSize: options per page (capped by the API). - uploadProcessName / uploadResultIdField: a process the picker can run to add a record (e.g., upload an image); when it completes, the new record's id is read from this process output value and selected.
See Also:

  • Constructor Details

    • QPossibleValuePicker

      public QPossibleValuePicker()

  • Method Details

    • getDisplayFieldNames

      public Set<String> getDisplayFieldNames()
      Every field a picker request may return per option (thumbnail, preview, subtitle and detail fields), in declaration order, without duplicates.

    • getThumbnailField

      public String getThumbnailField()
      Getter for thumbnailField

    • setThumbnailField

      public void setThumbnailField(String thumbnailField)
      Setter for thumbnailField

    • withThumbnailField

      public QPossibleValuePicker withThumbnailField(String thumbnailField)
      Fluent setter for thumbnailField

    • getPreviewField

      public String getPreviewField()
      Getter for previewField

    • setPreviewField

      public void setPreviewField(String previewField)
      Setter for previewField

    • withPreviewField

      public QPossibleValuePicker withPreviewField(String previewField)
      Fluent setter for previewField

    • getSubtitleFields

      public List<String> getSubtitleFields()
      Getter for subtitleFields

    • setSubtitleFields

      public void setSubtitleFields(List<String> subtitleFields)
      Setter for subtitleFields

    • withSubtitleFields

      public QPossibleValuePicker withSubtitleFields(List<String> subtitleFields)
      Fluent setter for subtitleFields

    • getDetailFields

      public List<String> getDetailFields()
      Getter for detailFields

    • setDetailFields

      public void setDetailFields(List<String> detailFields)
      Setter for detailFields

    • withDetailFields

      public QPossibleValuePicker withDetailFields(List<String> detailFields)
      Fluent setter for detailFields

    • getFilterFields

      public List<String> getFilterFields()
      Getter for filterFields

    • setFilterFields

      public void setFilterFields(List<String> filterFields)
      Setter for filterFields

    • withFilterFields

      public QPossibleValuePicker withFilterFields(List<String> filterFields)
      Fluent setter for filterFields

    • getSearchFields

      public List<String> getSearchFields()
      Getter for searchFields

    • setSearchFields

      public void setSearchFields(List<String> searchFields)
      Setter for searchFields

    • withSearchFields

      public QPossibleValuePicker withSearchFields(List<String> searchFields)
      Fluent setter for searchFields

    • getSorts

      public List<QPossibleValuePicker.Sort> getSorts()
      Getter for sorts

    • setSorts

      public void setSorts(List<QPossibleValuePicker.Sort> sorts)
      Setter for sorts

    • withSorts

      public QPossibleValuePicker withSorts(List<QPossibleValuePicker.Sort> sorts)
      Fluent setter for sorts

    • withSort

      public QPossibleValuePicker withSort(String label, String fieldName, boolean isAscending)
      Fluent adder for one sort

    • getPageSize

      public Integer getPageSize()
      Getter for pageSize

    • setPageSize

      public void setPageSize(Integer pageSize)
      Setter for pageSize

    • withPageSize

      public QPossibleValuePicker withPageSize(Integer pageSize)
      Fluent setter for pageSize

    • getUploadProcessName

      public String getUploadProcessName()
      Getter for uploadProcessName

    • setUploadProcessName

      public void setUploadProcessName(String uploadProcessName)
      Setter for uploadProcessName

    • withUploadProcessName

      public QPossibleValuePicker withUploadProcessName(String uploadProcessName)
      Fluent setter for uploadProcessName

    • getUploadResultIdField

      public String getUploadResultIdField()
      Getter for uploadResultIdField

    • setUploadResultIdField

      public void setUploadResultIdField(String uploadResultIdField)
      Setter for uploadResultIdField

    • withUploadResultIdField

      public QPossibleValuePicker withUploadResultIdField(String uploadResultIdField)
      Fluent setter for uploadResultIdField