Class GetAction

java.lang.Object

com.kingsrook.qqq.backend.core.actions.tables.GetAction

public class GetAction
extends Object

Action to run a get against a table.

Constructor Summary

Constructors

Constructor	Description
GetAction()

Method Summary

Modifier and Type	Method	Description
static QueryInput	convertGetInputToQueryInput(GetInput getInput)
GetOutput	execute(GetInput getInput)
static QRecord	execute(String tableName, Serializable primaryKey)	more shorthand way to call for the most common use-case, when you just want the output record to be returned, and you just want to pass in a table name and primary key.
static QRecord	execute(String tableName, Map<String,Serializable> uniqueKey)	more shorthand way to call for the most common use-case, when you just want the output record to be returned, and you just want to pass in a table name and unique key
QRecord	executeForRecord(GetInput getInput)	shorthand way to call for the most common use-case, when you just want the output record to be returned.
GetOutput	executeViaQuery(GetInput getInput)	Run a GetAction by using the QueryAction instead (e.g., with a filter made from the pkey/ukey, and returning the single record if found).
QRecord	postRecordActions(QRecord record)	Run the necessary actions on a record.

Methods inherited from class java.lang.Object

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

Constructor Details

GetAction

public GetAction()

Method Details

execute

public GetOutput execute(GetInput getInput)
                  throws QException

Throws:

QException

executeForRecord

public QRecord executeForRecord(GetInput getInput)
                         throws QException

shorthand way to call for the most common use-case, when you just want the output record to be returned.

Throws:

QException

execute

public static QRecord execute(String tableName,
 Serializable primaryKey)
                       throws QException

more shorthand way to call for the most common use-case, when you just want the output record to be returned, and you just want to pass in a table name and primary key.

Throws:

QException

execute

public static QRecord execute(String tableName,
 Map<String,Serializable> uniqueKey)
                       throws QException

more shorthand way to call for the most common use-case, when you just want the output record to be returned, and you just want to pass in a table name and unique key

Throws:

QException

executeViaQuery

public GetOutput executeViaQuery(GetInput getInput)
                          throws QException

Run a GetAction by using the QueryAction instead (e.g., with a filter made from the pkey/ukey, and returning the single record if found).

Throws:

QException

convertGetInputToQueryInput

public static QueryInput convertGetInputToQueryInput(GetInput getInput)
                                              throws QException

Throws:

QException

postRecordActions

public QRecord postRecordActions(QRecord record)
                          throws QException

Run the necessary actions on a record. This may include setting display values, translating possible values, and running post-record customizations.

Throws:

QException