Class QueryInput

java.lang.Object

com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput

com.kingsrook.qqq.backend.core.model.actions.AbstractTableActionInput

com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput

All Implemented Interfaces:

QueryOrCountInputInterface, QueryOrGetInputInterface, Cloneable

public class QueryInput
extends AbstractTableActionInput
implements QueryOrGetInputInterface, QueryOrCountInputInterface, Cloneable

Input data for the Query action Todo - maybe make a class between AbstractTableActionInput and {QueryInput, CountInput, and AggregateInput}, with common attributes for all of these "read" operations (like, queryHints,

Constructor Summary

Constructors

Constructor	Description
QueryInput()
QueryInput(String tableName)	Constructor

Method Summary

Modifier and Type	Method	Description
void	applyRawReadFlags()	Set the individual flags that make up a raw read.
QueryInput	clone()
Collection<String>	getAssociationNamesToInclude()	Getter for associationNamesToInclude
Set<String>	getFieldNamesToInclude()	Getter for fieldNamesToInclude
Set<String>	getFieldsToTranslatePossibleValues()	Getter for fieldsToTranslatePossibleValues
QQueryFilter	getFilter()	Getter for filter
Set<ActionFlag>	getFlags()	Getter for flags
boolean	getIncludeAssociations()	Getter for includeAssociations
QueryLockMode	getLockMode()	Getter for lockMode: row locks to take (null for none).
EnumSet<QueryHint>	getQueryHints()	Getter for queryHints
List<QueryJoin>	getQueryJoins()	Getter for queryJoins
RawReadReason	getRawReadReason()	Getter for rawReadReason - non-null if this is a raw read.
RecordPipe	getRecordPipe()	Getter for recordPipe
boolean	getSelectDistinct()	Getter for selectDistinct
boolean	getShouldFetchHeavyFields()	Getter for shouldFetchHeavyFields
boolean	getShouldGenerateDisplayValues()	Getter for shouldGenerateDisplayValues
boolean	getShouldMaskPasswords()	Getter for shouldMaskPasswords
boolean	getShouldOmitHiddenFields()	Getter for shouldOmitHiddenFields
boolean	getShouldTranslatePossibleValues()	Getter for shouldTranslatePossibleValues
Integer	getTimeoutSeconds()	Getter for timeoutSeconds
QBackendTransaction	getTransaction()	Getter for transaction
boolean	hasFlag(ActionFlag flag)
boolean	hasQueryHint(QueryHint queryHint)	null-safely check if query hints map contains the specified hint
void	setAssociationNamesToInclude(Collection<String> associationNamesToInclude)	Setter for associationNamesToInclude
void	setFieldNamesToInclude(Set<String> fieldNamesToInclude)	Setter for fieldNamesToInclude
void	setFieldsToTranslatePossibleValues(Set<String> fieldsToTranslatePossibleValues)	Setter for fieldsToTranslatePossibleValues
void	setFilter(QQueryFilter filter)	Setter for filter
void	setFlags(Set<ActionFlag> flags)	Setter for flags
void	setIncludeAssociations(boolean includeAssociations)	Setter for includeAssociations
void	setLockMode(QueryLockMode lockMode)	Setter for lockMode
void	setQueryHints(EnumSet<QueryHint> queryHints)	Setter for queryHints
void	setQueryJoins(List<QueryJoin> queryJoins)	Setter for queryJoins
void	setRecordPipe(RecordPipe recordPipe)	Setter for recordPipe
void	setSelectDistinct(boolean selectDistinct)	Setter for selectDistinct
void	setShouldFetchHeavyFields(boolean shouldFetchHeavyFields)	Setter for shouldFetchHeavyFields
void	setShouldGenerateDisplayValues(boolean shouldGenerateDisplayValues)	Setter for shouldGenerateDisplayValues
void	setShouldMaskPasswords(boolean shouldMaskPasswords)	Setter for shouldMaskPasswords
void	setShouldOmitHiddenFields(boolean shouldOmitHiddenFields)	Setter for shouldOmitHiddenFields
void	setShouldTranslatePossibleValues(boolean shouldTranslatePossibleValues)	Setter for shouldTranslatePossibleValues
void	setTimeoutSeconds(Integer timeoutSeconds)	Setter for timeoutSeconds
void	setTransaction(QBackendTransaction transaction)	Setter for transaction
QueryInput	withAssociationNamesToInclude(Collection<String> associationNamesToInclude)	Fluent setter for associationNamesToInclude
QueryInput	withFieldNamesToInclude(Set<String> fieldNamesToInclude)	Fluent setter for fieldNamesToInclude
QueryInput	withFieldsToTranslatePossibleValues(Set<String> fieldsToTranslatePossibleValues)	Fluent setter for fieldsToTranslatePossibleValues
QueryInput	withFilter(QQueryFilter filter)	Fluent setter for filter
QueryInput	withFlag(ActionFlag flag)
QueryInput	withFlags(Set<ActionFlag> flags)	Fluent setter for flags
QueryInput	withIncludeAssociations(boolean includeAssociations)	Fluent setter for includeAssociations
QueryInput	withInputSource(InputSource inputSource)	Fluent setter for inputSource
QueryInput	withLockMode(QueryLockMode lockMode)	Fluent setter for lockMode
QueryInput	withoutQueryHint(QueryHint queryHint)	Fluent setter for queryHints
QueryInput	withQueryHint(QueryHint queryHint)	Fluent setter for queryHints
QueryInput	withQueryHints(EnumSet<QueryHint> queryHints)	Fluent setter for queryHints
QueryInput	withQueryJoin(QueryJoin queryJoin)	Fluent setter for queryJoins
QueryInput	withQueryJoins(List<QueryJoin> queryJoins)	Fluent setter for queryJoins
QueryInput	withRawRead(RawReadReason rawReadReason)	Opt in to a "raw read": hidden fields are returned, password fields are not masked, heavy fields are fetched, and possible-value translation and display values are skipped.
QueryInput	withRecordPipe(RecordPipe recordPipe)	Fluent setter for recordPipe
QueryInput	withSelectDistinct(boolean selectDistinct)	Fluent setter for selectDistinct
QueryInput	withShouldFetchHeavyFields(boolean shouldFetchHeavyFields)	Fluent setter for shouldFetchHeavyFields
QueryInput	withShouldGenerateDisplayValues(boolean shouldGenerateDisplayValues)	Fluent setter for shouldGenerateDisplayValues
QueryInput	withShouldMaskPasswords(boolean shouldMaskPasswords)	Fluent setter for shouldMaskPasswords
QueryInput	withShouldOmitHiddenFields(boolean shouldOmitHiddenFields)	Fluent setter for shouldOmitHiddenFields
QueryInput	withShouldTranslatePossibleValues(boolean shouldTranslatePossibleValues)	Fluent setter for shouldTranslatePossibleValues
QueryInput	withTableName(String tableName)	Fluent setter for tableName
QueryInput	withTimeoutSeconds(Integer timeoutSeconds)	Fluent setter for timeoutSeconds
QueryInput	withTransaction(QBackendTransaction transaction)	Fluent setter for transaction

Methods inherited from class com.kingsrook.qqq.backend.core.model.actions.AbstractTableActionInput

getActionIdentity, getBackend, getInputSource, getTable, getTableMetaData, getTableName, setInputSource, setTableMetaData, setTableName, withTableMetaData

Methods inherited from class com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput

getAsyncJobCallback, getPermissionBypassReason, getPermissionEnforcement, setAsyncJobCallback, setPermissionEnforcement, withPermissionBypass, withPermissionEnforcement

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.model.actions.tables.QueryOrCountInputInterface

getInputSource, getTable, getTableName, setCommonParamsFrom, setTableName

Methods inherited from interface com.kingsrook.qqq.backend.core.model.actions.tables.QueryOrGetInputInterface

getTableName, setCommonParamsFrom

Constructor Details

QueryInput

public QueryInput()

QueryInput

public QueryInput(String tableName)

Constructor

Method Details

clone

public QueryInput clone()
                 throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getFilter

public QQueryFilter getFilter()

Getter for filter

Specified by:

getFilter in interface QueryOrCountInputInterface

setFilter

public void setFilter(QQueryFilter filter)

Setter for filter

Specified by:

setFilter in interface QueryOrCountInputInterface

getRecordPipe

public RecordPipe getRecordPipe()

Getter for recordPipe

setRecordPipe

public void setRecordPipe(RecordPipe recordPipe)

Setter for recordPipe

getShouldTranslatePossibleValues

public boolean getShouldTranslatePossibleValues()

Getter for shouldTranslatePossibleValues

Specified by:

getShouldTranslatePossibleValues in interface QueryOrGetInputInterface

setShouldTranslatePossibleValues

public void setShouldTranslatePossibleValues(boolean shouldTranslatePossibleValues)

Setter for shouldTranslatePossibleValues

Specified by:

setShouldTranslatePossibleValues in interface QueryOrGetInputInterface

getShouldGenerateDisplayValues

public boolean getShouldGenerateDisplayValues()

Getter for shouldGenerateDisplayValues

Specified by:

getShouldGenerateDisplayValues in interface QueryOrGetInputInterface

setShouldGenerateDisplayValues

public void setShouldGenerateDisplayValues(boolean shouldGenerateDisplayValues)

Setter for shouldGenerateDisplayValues

Specified by:

setShouldGenerateDisplayValues in interface QueryOrGetInputInterface

getShouldFetchHeavyFields

public boolean getShouldFetchHeavyFields()

Getter for shouldFetchHeavyFields

Specified by:

getShouldFetchHeavyFields in interface QueryOrGetInputInterface

setShouldFetchHeavyFields

public void setShouldFetchHeavyFields(boolean shouldFetchHeavyFields)

Setter for shouldFetchHeavyFields

Specified by:

setShouldFetchHeavyFields in interface QueryOrGetInputInterface

getTransaction

public QBackendTransaction getTransaction()

Getter for transaction

Specified by:

getTransaction in interface QueryOrCountInputInterface

Specified by:

getTransaction in interface QueryOrGetInputInterface

setTransaction

public void setTransaction(QBackendTransaction transaction)

Setter for transaction

Specified by:

setTransaction in interface QueryOrCountInputInterface

Specified by:

setTransaction in interface QueryOrGetInputInterface

withTransaction

public QueryInput withTransaction(QBackendTransaction transaction)

Fluent setter for transaction

getQueryJoins

public List<QueryJoin> getQueryJoins()

Getter for queryJoins

Specified by:

getQueryJoins in interface QueryOrCountInputInterface

Specified by:

getQueryJoins in interface QueryOrGetInputInterface

setQueryJoins

public void setQueryJoins(List<QueryJoin> queryJoins)

Setter for queryJoins

Specified by:

setQueryJoins in interface QueryOrCountInputInterface

Specified by:

setQueryJoins in interface QueryOrGetInputInterface

withQueryJoins

public QueryInput withQueryJoins(List<QueryJoin> queryJoins)

Fluent setter for queryJoins

withQueryJoin

public QueryInput withQueryJoin(QueryJoin queryJoin)

Fluent setter for queryJoins

getFieldsToTranslatePossibleValues

public Set<String> getFieldsToTranslatePossibleValues()

Getter for fieldsToTranslatePossibleValues

setFieldsToTranslatePossibleValues

public void setFieldsToTranslatePossibleValues(Set<String> fieldsToTranslatePossibleValues)

Setter for fieldsToTranslatePossibleValues

withFieldsToTranslatePossibleValues

public QueryInput withFieldsToTranslatePossibleValues(Set<String> fieldsToTranslatePossibleValues)

Fluent setter for fieldsToTranslatePossibleValues

withFilter

public QueryInput withFilter(QQueryFilter filter)

Fluent setter for filter

withRecordPipe

public QueryInput withRecordPipe(RecordPipe recordPipe)

Fluent setter for recordPipe

withShouldTranslatePossibleValues

public QueryInput withShouldTranslatePossibleValues(boolean shouldTranslatePossibleValues)

Fluent setter for shouldTranslatePossibleValues

withShouldGenerateDisplayValues

public QueryInput withShouldGenerateDisplayValues(boolean shouldGenerateDisplayValues)

Fluent setter for shouldGenerateDisplayValues

withShouldFetchHeavyFields

public QueryInput withShouldFetchHeavyFields(boolean shouldFetchHeavyFields)

Fluent setter for shouldFetchHeavyFields

withTableName

public QueryInput withTableName(String tableName)

Description copied from class: AbstractTableActionInput

Fluent setter for tableName

Overrides:

withTableName in class AbstractTableActionInput

getIncludeAssociations

public boolean getIncludeAssociations()

Getter for includeAssociations

Specified by:

getIncludeAssociations in interface QueryOrGetInputInterface

setIncludeAssociations

public void setIncludeAssociations(boolean includeAssociations)

Setter for includeAssociations

Specified by:

setIncludeAssociations in interface QueryOrGetInputInterface

withIncludeAssociations

public QueryInput withIncludeAssociations(boolean includeAssociations)

Fluent setter for includeAssociations

getAssociationNamesToInclude

public Collection<String> getAssociationNamesToInclude()

Getter for associationNamesToInclude

Specified by:

getAssociationNamesToInclude in interface QueryOrGetInputInterface

setAssociationNamesToInclude

public void setAssociationNamesToInclude(Collection<String> associationNamesToInclude)

Setter for associationNamesToInclude

Specified by:

setAssociationNamesToInclude in interface QueryOrGetInputInterface

withAssociationNamesToInclude

public QueryInput withAssociationNamesToInclude(Collection<String> associationNamesToInclude)

Fluent setter for associationNamesToInclude

getShouldMaskPasswords

public boolean getShouldMaskPasswords()

Getter for shouldMaskPasswords

Specified by:

getShouldMaskPasswords in interface QueryOrGetInputInterface

setShouldMaskPasswords

public void setShouldMaskPasswords(boolean shouldMaskPasswords)

Setter for shouldMaskPasswords

Specified by:

setShouldMaskPasswords in interface QueryOrGetInputInterface

withShouldMaskPasswords

public QueryInput withShouldMaskPasswords(boolean shouldMaskPasswords)

Fluent setter for shouldMaskPasswords

getShouldOmitHiddenFields

public boolean getShouldOmitHiddenFields()

Getter for shouldOmitHiddenFields

Specified by:

getShouldOmitHiddenFields in interface QueryOrGetInputInterface

setShouldOmitHiddenFields

public void setShouldOmitHiddenFields(boolean shouldOmitHiddenFields)

Setter for shouldOmitHiddenFields

Specified by:

setShouldOmitHiddenFields in interface QueryOrGetInputInterface

withShouldOmitHiddenFields

public QueryInput withShouldOmitHiddenFields(boolean shouldOmitHiddenFields)

Fluent setter for shouldOmitHiddenFields

getSelectDistinct

public boolean getSelectDistinct()

Getter for selectDistinct

setSelectDistinct

public void setSelectDistinct(boolean selectDistinct)

Setter for selectDistinct

withSelectDistinct

public QueryInput withSelectDistinct(boolean selectDistinct)

Fluent setter for selectDistinct

getTimeoutSeconds

public Integer getTimeoutSeconds()

Getter for timeoutSeconds

Specified by:

getTimeoutSeconds in interface QueryOrCountInputInterface

setTimeoutSeconds

public void setTimeoutSeconds(Integer timeoutSeconds)

Setter for timeoutSeconds

Specified by:

setTimeoutSeconds in interface QueryOrCountInputInterface

withTimeoutSeconds

public QueryInput withTimeoutSeconds(Integer timeoutSeconds)

Fluent setter for timeoutSeconds

getQueryHints

public EnumSet<QueryHint> getQueryHints()

Getter for queryHints

Specified by:

getQueryHints in interface QueryOrCountInputInterface

setQueryHints

public void setQueryHints(EnumSet<QueryHint> queryHints)

Setter for queryHints

Specified by:

setQueryHints in interface QueryOrCountInputInterface

withQueryHints

public QueryInput withQueryHints(EnumSet<QueryHint> queryHints)

Fluent setter for queryHints

withQueryHint

public QueryInput withQueryHint(QueryHint queryHint)

Fluent setter for queryHints

withoutQueryHint

public QueryInput withoutQueryHint(QueryHint queryHint)

Fluent setter for queryHints

hasQueryHint

public boolean hasQueryHint(QueryHint queryHint)

null-safely check if query hints map contains the specified hint

getFieldNamesToInclude

public Set<String> getFieldNamesToInclude()

Getter for fieldNamesToInclude

setFieldNamesToInclude

public void setFieldNamesToInclude(Set<String> fieldNamesToInclude)

Setter for fieldNamesToInclude

withFieldNamesToInclude

public QueryInput withFieldNamesToInclude(Set<String> fieldNamesToInclude)

Fluent setter for fieldNamesToInclude

getFlags

public Set<ActionFlag> getFlags()

Getter for flags

See Also:

• withFlags(Set)

setFlags

public void setFlags(Set<ActionFlag> flags)

Setter for flags

See Also:

• withFlags(Set)

withFlags

public QueryInput withFlags(Set<ActionFlag> flags)

Fluent setter for flags

Parameters:

flags - framework, backend-module, or application defined flags that con be used to drive behaviors. For example, maybe to bypass caching actions, or to customize a query, etc.

Returns:

this

withFlag

public QueryInput withFlag(ActionFlag flag)

hasFlag

public boolean hasFlag(ActionFlag flag)

withInputSource

public QueryInput withInputSource(InputSource inputSource)

Description copied from class: AbstractTableActionInput

Fluent setter for inputSource

Overrides:

withInputSource in class AbstractTableActionInput

Parameters:

inputSource - Indicator of what the source of the action is. Default values from QQQ are USER or SYSTEM (where it can be the case that an action that originated from a USER leads to SYSTEM actions (e.g., running a process - the RunProcessAction is USER initiated, but if that process then runs a query, by default, it would be SYSTEM initiated).

Returns:

this

withRawRead

public QueryInput withRawRead(RawReadReason rawReadReason)

Opt in to a "raw read": hidden fields are returned, password fields are not masked, heavy fields are fetched, and possible-value translation and display values are skipped. The flags are set here, and re-applied (and the reason's permission check and an audit are done) when the query executes, so a raw read can't be granted by flipping the individual flags, nor undone later by them. Record locks and field security locks still apply, unless the session has the all-access security keys.

applyRawReadFlags

public void applyRawReadFlags()

Set the individual flags that make up a raw read.

getRawReadReason

public RawReadReason getRawReadReason()

Getter for rawReadReason - non-null if this is a raw read.

getLockMode

public QueryLockMode getLockMode()

Getter for lockMode: row locks to take (null for none). Only on backends that support the mode; run inside a transaction.

setLockMode

public void setLockMode(QueryLockMode lockMode)

Setter for lockMode

withLockMode

public QueryInput withLockMode(QueryLockMode lockMode)

Fluent setter for lockMode