Class QueryAction

java.lang.Object

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

public class QueryAction
extends Object

Action to run a query against a table.

Constructor Summary

Constructors

Constructor	Description
QueryAction()

Method Summary

Modifier and Type	Method	Description
void	cancel()
QueryOutput	execute(QueryInput queryInput)
static List<QRecord>	execute(String tableName, QQueryFilter filter)	shorthand way to call for the most common use-case, when you just want the records to be returned, and you just want to pass in a table name and filter.
static <T extends QRecordEntity> List<T>	execute(String tableName, Class<T> entityClass, QQueryFilter filter)	shorthand way to call for the most common use-case, when you just want the entities to be returned, and you just want to pass in a table name and filter.
void	postRecordActions(List<QRecord> records)	Run the necessary actions on a list of records (which must be a mutable list - e.g., not one created via List.of()).

Methods inherited from class java.lang.Object

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

Constructor Details

QueryAction

public QueryAction()

Method Details

execute

public QueryOutput execute(QueryInput queryInput)
                    throws QException

Throws:

QException

execute

public static <T extends QRecordEntity> List<T> execute(String tableName,
 Class<T> entityClass,
 QQueryFilter filter)
                                                 throws QException

shorthand way to call for the most common use-case, when you just want the entities to be returned, and you just want to pass in a table name and filter.

Throws:

QException

execute

public static List<QRecord> execute(String tableName,
 QQueryFilter filter)
                             throws QException

shorthand way to call for the most common use-case, when you just want the records to be returned, and you just want to pass in a table name and filter.

Throws:

QException

postRecordActions

public void postRecordActions(List<QRecord> records)
                       throws QException

Run the necessary actions on a list of records (which must be a mutable list - e.g., not one created via List.of()). This may include setting display values, translating possible values, and running post-record customizations.

Throws:

QException

cancel

public void cancel()