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:
QueryOrGetInputInterface, Cloneable
public class QueryInput extends AbstractTableActionInput implements QueryOrGetInputInterface, 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 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

    • setFilter

      public void setFilter(QQueryFilter filter)
      Setter for filter

    • 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 QueryOrGetInputInterface

    • setTransaction

      public void setTransaction(QBackendTransaction transaction)
      Setter for transaction
      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 QueryOrGetInputInterface

    • setQueryJoins

      public void setQueryJoins(List<QueryJoin> queryJoins)
      Setter for queryJoins
      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

    • setTimeoutSeconds

      public void setTimeoutSeconds(Integer timeoutSeconds)
      Setter for timeoutSeconds

    • withTimeoutSeconds

      public QueryInput withTimeoutSeconds(Integer timeoutSeconds)
      Fluent setter for timeoutSeconds

    • getQueryHints

      public EnumSet<QueryHint> getQueryHints()
      Getter for queryHints

    • setQueryHints

      public void setQueryHints(EnumSet<QueryHint> queryHints)
      Setter for queryHints

    • 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