Class GetInput

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.get.GetInput

All Implemented Interfaces:

QueryOrGetInputInterface

public class GetInput
extends AbstractTableActionInput
implements QueryOrGetInputInterface

Input data for the Get action

Constructor Summary

Constructors

Constructor	Description
GetInput()
GetInput(String tableName)	Constructor

Method Summary

Modifier and Type	Method	Description
Collection<String>	getAssociationNamesToInclude()	Getter for associationNamesToInclude
boolean	getIncludeAssociations()	Getter for includeAssociations
Serializable	getPrimaryKey()	Getter for primaryKey
EnumSet<QueryHint>	getQueryHints()	Getter for queryHints
List<QueryJoin>	getQueryJoins()	Getter for queryJoins
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
QBackendTransaction	getTransaction()	Getter for transaction
Map<String,Serializable>	getUniqueKey()	Getter for uniqueKey
boolean	hasQueryHint(QueryHint queryHint)	null-safely check if query hints map contains the specified hint
void	setAssociationNamesToInclude(Collection<String> associationNamesToInclude)	Setter for associationNamesToInclude
void	setIncludeAssociations(boolean includeAssociations)	Setter for includeAssociations
void	setPrimaryKey(Serializable primaryKey)	Setter for primaryKey
void	setQueryHints(EnumSet<QueryHint> queryHints)	Setter for queryHints
void	setQueryJoins(List<QueryJoin> queryJoins)	Setter for queryJoins
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	setTransaction(QBackendTransaction transaction)	Setter for transaction
void	setUniqueKey(Map<String,Serializable> uniqueKey)	Setter for uniqueKey
GetInput	withAssociationNamesToInclude(Collection<String> associationNamesToInclude)	Fluent setter for associationNamesToInclude
GetInput	withIncludeAssociations(boolean includeAssociations)	Fluent setter for includeAssociations
GetInput	withInputSource(InputSource inputSource)	Fluent setter for inputSource
GetInput	withoutQueryHint(QueryHint queryHint)	Fluent setter for queryHints
GetInput	withPrimaryKey(Serializable primaryKey)	Fluent setter for primaryKey
GetInput	withQueryHint(QueryHint queryHint)	Fluent setter for queryHints
GetInput	withQueryHints(EnumSet<QueryHint> queryHints)	Fluent setter for queryHints
GetInput	withQueryJoin(QueryJoin queryJoin)	Fluent setter for queryJoins
GetInput	withQueryJoins(List<QueryJoin> queryJoins)	Fluent setter for queryJoins
GetInput	withShouldFetchHeavyFields(boolean shouldFetchHeavyFields)	Fluent setter for shouldFetchHeavyFields
GetInput	withShouldGenerateDisplayValues(boolean shouldGenerateDisplayValues)	Fluent setter for shouldGenerateDisplayValues
GetInput	withShouldMaskPasswords(boolean shouldMaskPasswords)	Fluent setter for shouldMaskPasswords
GetInput	withShouldOmitHiddenFields(boolean shouldOmitHiddenFields)	Fluent setter for shouldOmitHiddenFields
GetInput	withShouldTranslatePossibleValues(boolean shouldTranslatePossibleValues)	Fluent setter for shouldTranslatePossibleValues
AbstractTableActionInput	withTableName(String tableName)	Fluent setter for tableName
GetInput	withTransaction(QBackendTransaction transaction)	Fluent setter for transaction
GetInput	withUniqueKey(Map<String,Serializable> uniqueKey)	Fluent setter for uniqueKey

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, getInstance, getSession, setAsyncJobCallback

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.model.actions.tables.QueryOrGetInputInterface

getTableName, setCommonParamsFrom

Constructor Details

GetInput

public GetInput()

GetInput

public GetInput(String tableName)

Constructor

Method Details

withTableName

public AbstractTableActionInput withTableName(String tableName)

Description copied from class: AbstractTableActionInput

Fluent setter for tableName

Overrides:

withTableName in class AbstractTableActionInput

getPrimaryKey

public Serializable getPrimaryKey()

Getter for primaryKey

setPrimaryKey

public void setPrimaryKey(Serializable primaryKey)

Setter for primaryKey

withPrimaryKey

public GetInput withPrimaryKey(Serializable primaryKey)

Fluent setter for primaryKey

getUniqueKey

public Map<String,Serializable> getUniqueKey()

Getter for uniqueKey

setUniqueKey

public void setUniqueKey(Map<String,Serializable> uniqueKey)

Setter for uniqueKey

withUniqueKey

public GetInput withUniqueKey(Map<String,Serializable> uniqueKey)

Fluent setter for uniqueKey

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

getTransaction

public QBackendTransaction getTransaction()

Getter for transaction

Specified by:

getTransaction in interface QueryOrGetInputInterface

setTransaction

public void setTransaction(QBackendTransaction transaction)

Setter for transaction

Specified by:

setTransaction in interface QueryOrGetInputInterface

withTransaction

public GetInput withTransaction(QBackendTransaction transaction)

Fluent setter for transaction

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

withShouldFetchHeavyFields

public GetInput withShouldFetchHeavyFields(boolean shouldFetchHeavyFields)

Fluent setter for shouldFetchHeavyFields

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 GetInput 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 GetInput withAssociationNamesToInclude(Collection<String> associationNamesToInclude)

Fluent setter for associationNamesToInclude

withShouldTranslatePossibleValues

public GetInput withShouldTranslatePossibleValues(boolean shouldTranslatePossibleValues)

Fluent setter for shouldTranslatePossibleValues

withShouldGenerateDisplayValues

public GetInput withShouldGenerateDisplayValues(boolean shouldGenerateDisplayValues)

Fluent setter for shouldGenerateDisplayValues

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 GetInput 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 GetInput withShouldOmitHiddenFields(boolean shouldOmitHiddenFields)

Fluent setter for shouldOmitHiddenFields

getQueryJoins

public List<QueryJoin> getQueryJoins()

Getter for queryJoins

Specified by:

getQueryJoins in interface QueryOrGetInputInterface

setQueryJoins

public void setQueryJoins(List<QueryJoin> queryJoins)

Setter for queryJoins

Specified by:

setQueryJoins in interface QueryOrGetInputInterface

withQueryJoins

public GetInput withQueryJoins(List<QueryJoin> queryJoins)

Fluent setter for queryJoins

withQueryJoin

public GetInput withQueryJoin(QueryJoin queryJoin)

Fluent setter for queryJoins

getQueryHints

public EnumSet<QueryHint> getQueryHints()

Getter for queryHints

setQueryHints

public void setQueryHints(EnumSet<QueryHint> queryHints)

Setter for queryHints

withQueryHints

public GetInput withQueryHints(EnumSet<QueryHint> queryHints)

Fluent setter for queryHints

withQueryHint

public GetInput withQueryHint(QueryHint queryHint)

Fluent setter for queryHints

withoutQueryHint

public GetInput withoutQueryHint(QueryHint queryHint)

Fluent setter for queryHints

hasQueryHint

public boolean hasQueryHint(QueryHint queryHint)

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

withInputSource

public GetInput 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