Class APIQueryAction

java.lang.Object

com.kingsrook.qqq.backend.module.api.actions.AbstractAPIAction

com.kingsrook.qqq.backend.module.api.actions.APIQueryAction

All Implemented Interfaces:

BaseQueryInterface, QueryInterface

public class APIQueryAction
extends AbstractAPIAction
implements QueryInterface

Field Summary

Fields inherited from class com.kingsrook.qqq.backend.module.api.actions.AbstractAPIAction

apiActionUtil, backendMetaData, session

Constructor Summary

Constructors

Constructor	Description
APIQueryAction()

Method Summary

Modifier and Type	Method	Description
QueryOutput	execute(QueryInput queryInput)
List<Serializable>	findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input)	API filter syntax is application-specific, so read all pages and match locally.
List<QRecord>	lookupUniqueKey(UniqueKeyLookup.Input input)	Complete key visibility must be supplied by the configured provider utility.
List<QRecord>	readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input)	The configured provider must explicitly support complete stored parent values.

Methods inherited from class com.kingsrook.qqq.backend.module.api.actions.AbstractAPIAction

preAction

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.actions.interfaces.BaseQueryInterface

cancelAction, getQueryStat, setQueryStat, setQueryStatFirstResultTime

Methods inherited from interface com.kingsrook.qqq.backend.core.actions.interfaces.QueryInterface

executeForDml

Constructor Details

APIQueryAction

public APIQueryAction()

Method Details

execute

public QueryOutput execute(QueryInput queryInput)
                    throws QException

Specified by:

execute in interface QueryInterface

Throws:

QException

lookupUniqueKey

public List<QRecord> lookupUniqueKey(UniqueKeyLookup.Input input)
                              throws QException

Complete key visibility must be supplied by the configured provider utility.

Specified by:

lookupUniqueKey in interface QueryInterface

Throws:

QException

readAssociationValues

public List<QRecord> readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input)
                                    throws QException

The configured provider must explicitly support complete stored parent values.

Specified by:

readAssociationValues in interface QueryInterface

Throws:

QException

findAssociatedPrimaryKeys

public List<Serializable> findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input)
                                             throws QException

API filter syntax is application-specific, so read all pages and match locally.

Specified by:

findAssociatedPrimaryKeys in interface QueryInterface

Throws:

QException