com.squareup.square.models

Class CatalogQuery

java.lang.Object

com.squareup.square.models.CatalogQuery

public class CatalogQuery
extends Object

This is a model class for CatalogQuery type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogQuery.Builder Class to build instances of CatalogQuery.

Constructor Summary

Constructors

Constructor and Description

CatalogQuery(CatalogQuerySortedAttribute sortedAttributeQuery, CatalogQueryExact exactQuery, CatalogQuerySet setQuery, CatalogQueryPrefix prefixQuery, CatalogQueryRange rangeQuery, CatalogQueryText textQuery, CatalogQueryItemsForTax itemsForTaxQuery, CatalogQueryItemsForModifierList itemsForModifierListQuery, CatalogQueryItemsForItemOptions itemsForItemOptionsQuery, CatalogQueryItemVariationsForItemOptionValues itemVariationsForItemOptionValuesQuery) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
CatalogQueryExact	getExactQuery() Getter for ExactQuery.
CatalogQueryItemsForItemOptions	getItemsForItemOptionsQuery() Getter for ItemsForItemOptionsQuery.
CatalogQueryItemsForModifierList	getItemsForModifierListQuery() Getter for ItemsForModifierListQuery.
CatalogQueryItemsForTax	getItemsForTaxQuery() Getter for ItemsForTaxQuery.
CatalogQueryItemVariationsForItemOptionValues	getItemVariationsForItemOptionValuesQuery() Getter for ItemVariationsForItemOptionValuesQuery.
CatalogQueryPrefix	getPrefixQuery() Getter for PrefixQuery.
CatalogQueryRange	getRangeQuery() Getter for RangeQuery.
CatalogQuerySet	getSetQuery() Getter for SetQuery.
CatalogQuerySortedAttribute	getSortedAttributeQuery() Getter for SortedAttributeQuery.
CatalogQueryText	getTextQuery() Getter for TextQuery.
int	hashCode()
CatalogQuery.Builder	toBuilder() Builds a new CatalogQuery.Builder object.
String	toString() Converts this CatalogQuery into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CatalogQuery

public CatalogQuery(CatalogQuerySortedAttribute sortedAttributeQuery,
                    CatalogQueryExact exactQuery,
                    CatalogQuerySet setQuery,
                    CatalogQueryPrefix prefixQuery,
                    CatalogQueryRange rangeQuery,
                    CatalogQueryText textQuery,
                    CatalogQueryItemsForTax itemsForTaxQuery,
                    CatalogQueryItemsForModifierList itemsForModifierListQuery,
                    CatalogQueryItemsForItemOptions itemsForItemOptionsQuery,
                    CatalogQueryItemVariationsForItemOptionValues itemVariationsForItemOptionValuesQuery)

Initialization constructor.

Parameters:

sortedAttributeQuery - CatalogQuerySortedAttribute value for sortedAttributeQuery.

exactQuery - CatalogQueryExact value for exactQuery.

setQuery - CatalogQuerySet value for setQuery.

prefixQuery - CatalogQueryPrefix value for prefixQuery.

rangeQuery - CatalogQueryRange value for rangeQuery.

textQuery - CatalogQueryText value for textQuery.

itemsForTaxQuery - CatalogQueryItemsForTax value for itemsForTaxQuery.

itemsForModifierListQuery - CatalogQueryItemsForModifierList value for itemsForModifierListQuery.

itemsForItemOptionsQuery - CatalogQueryItemsForItemOptions value for itemsForItemOptionsQuery.

itemVariationsForItemOptionValuesQuery - CatalogQueryItemVariationsForItemOptionValues value for itemVariationsForItemOptionValuesQuery.

Method Detail

getSortedAttributeQuery

public CatalogQuerySortedAttribute getSortedAttributeQuery()

Getter for SortedAttributeQuery. The query expression to specify the key to sort search results.

Returns:

Returns the CatalogQuerySortedAttribute

getExactQuery

public CatalogQueryExact getExactQuery()

Getter for ExactQuery. The query filter to return the search result by exact match of the specified attribute name and value.

Returns:

Returns the CatalogQueryExact

getSetQuery

public CatalogQuerySet getSetQuery()

Getter for SetQuery. The query filter to return the search result(s) by exact match of the specified `attribute_name` and any of the `attribute_values`.

Returns:

Returns the CatalogQuerySet

getPrefixQuery

public CatalogQueryPrefix getPrefixQuery()

Getter for PrefixQuery. The query filter to return the search result whose named attribute values are prefixed by the specified attribute value.

Returns:

Returns the CatalogQueryPrefix

getRangeQuery

public CatalogQueryRange getRangeQuery()

Getter for RangeQuery. The query filter to return the search result whose named attribute values fall between the specified range.

Returns:

Returns the CatalogQueryRange

getTextQuery

public CatalogQueryText getTextQuery()

Getter for TextQuery. The query filter to return the search result whose searchable attribute values contain all of the specified keywords or tokens, independent of the token order or case.

Returns:

Returns the CatalogQueryText

getItemsForTaxQuery

public CatalogQueryItemsForTax getItemsForTaxQuery()

Getter for ItemsForTaxQuery. The query filter to return the items containing the specified tax IDs.

Returns:

Returns the CatalogQueryItemsForTax

getItemsForModifierListQuery

public CatalogQueryItemsForModifierList getItemsForModifierListQuery()

Getter for ItemsForModifierListQuery. The query filter to return the items containing the specified modifier list IDs.

Returns:

Returns the CatalogQueryItemsForModifierList

getItemsForItemOptionsQuery

public CatalogQueryItemsForItemOptions getItemsForItemOptionsQuery()

Getter for ItemsForItemOptionsQuery. The query filter to return the items containing the specified item option IDs.

Returns:

Returns the CatalogQueryItemsForItemOptions

getItemVariationsForItemOptionValuesQuery

public CatalogQueryItemVariationsForItemOptionValues getItemVariationsForItemOptionValuesQuery()

Getter for ItemVariationsForItemOptionValuesQuery. The query filter to return the item variations containing the specified item option value IDs.

Returns:

Returns the CatalogQueryItemVariationsForItemOptionValues

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this CatalogQuery into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogQuery.Builder toBuilder()

Builds a new CatalogQuery.Builder object. Creates the instance with the state of the current model.

Returns:

a new CatalogQuery.Builder object