Class RelatedRecordPickerAction

java.lang.Object

com.kingsrook.qqq.backend.core.actions.tables.picker.RelatedRecordPickerAction

public class RelatedRecordPickerAction
extends Object

Serves related-record pickers (QRelatedRecordPicker): query the target table, prepare child rows, add them, and remove links. Every read and write runs as the user through the standard actions (permissions, record security locks, validation, audit). See docs/RELATED-RECORD-PICKER.md.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RelatedRecordPickerAction.Resolved	A picker with its tables and join fields worked out.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_LIMIT
static final int	MAX_LIMIT

Constructor Summary

Constructors

Constructor	Description
RelatedRecordPickerAction()

Method Summary

Modifier and Type	Method	Description
RelatedRecordPickerOutput	add(RelatedRecordPickerInput input)	Insert one child row per target (or per given record), all or nothing.
RelatedRecordPickerOutput	prepare(RelatedRecordPickerInput input)	Build (without saving) one child row per target, with defaults, values copied from the target, and the forced join values.
RelatedRecordPickerOutput	query(RelatedRecordPickerInput input)	Query the target table: the user's filter AND the picker's filter AND the search, one page, with hasMore (no count) and the already-linked targets.
RelatedRecordPickerOutput	remove(RelatedRecordPickerInput input)	Delete this parent's join rows for the given targets (LINK only).
static RelatedRecordPickerAction.Resolved	resolve(QInstance qInstance, QTableMetaData table, QRelatedRecordPicker picker)	Resolve a picker's tables and join fields, or null when the metadata does not resolve (the validator reports why).
static RelatedRecordPickerAction.Resolved	resolve(String tableName, String pickerName)	Find a table's picker and resolve its tables and join fields.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

• Constant Field Values

MAX_LIMIT

public static final int MAX_LIMIT

See Also:

• Constant Field Values

Constructor Details

RelatedRecordPickerAction

public RelatedRecordPickerAction()

Method Details

resolve

public static RelatedRecordPickerAction.Resolved resolve(String tableName,
 String pickerName)
                                                  throws QException

Find a table's picker and resolve its tables and join fields.

Throws:

QNotFoundException - for an unknown table or picker

QException

resolve

public static RelatedRecordPickerAction.Resolved resolve(QInstance qInstance,
 QTableMetaData table,
 QRelatedRecordPicker picker)

Resolve a picker's tables and join fields, or null when the metadata does not resolve (the validator reports why).

query

public RelatedRecordPickerOutput query(RelatedRecordPickerInput input)
                                throws QException

Query the target table: the user's filter AND the picker's filter AND the search, one page, with hasMore (no count) and the already-linked targets.

Throws:

QException

prepare

public RelatedRecordPickerOutput prepare(RelatedRecordPickerInput input)
                                  throws QException

Build (without saving) one child row per target, with defaults, values copied from the target, and the forced join values.

Throws:

QException

add

public RelatedRecordPickerOutput add(RelatedRecordPickerInput input)
                              throws QException

Insert one child row per target (or per given record), all or nothing.

Throws:

QException

remove

public RelatedRecordPickerOutput remove(RelatedRecordPickerInput input)
                                 throws QException

Delete this parent's join rows for the given targets (LINK only).

Throws:

QException