com.adobe.cq.commerce.magento.graphql

Class ProductsQuery

java.lang.Object

com.shopify.graphql.support.AbstractQuery<ProductsQuery>

com.adobe.cq.commerce.magento.graphql.ProductsQuery

public class ProductsQuery
extends AbstractQuery<ProductsQuery>

The Products object is the top-level object returned in a product search.

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractQuery

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method and Description
ProductsQuery	addFragmentReference(Fragment<ProductsQuery> fragment) Adds a ProductsQuery fragment reference at the current position of the query.
ProductsQuery	aggregations(AggregationQueryDefinition queryDef) Layered navigation aggregations.
static Fragment<ProductsQuery>	createFragment(String name, ProductsQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
ProductsQuery	filters(LayerFilterQueryDefinition queryDef) Deprecated. Use aggregations instead
ProductsQuery	items(ProductInterfaceQueryDefinition queryDef) An array of products that match the specified search criteria.
ProductsQuery	pageInfo(SearchResultPageInfoQueryDefinition queryDef) An object that includes the page_info and currentPage values specified in the query.
ProductsQuery	sortFields(SortFieldsQueryDefinition queryDef) An object that includes the default sort field and all available sort fields.
ProductsQuery	totalCount() The number of products that are marked as visible.

Methods inherited from class com.shopify.graphql.support.AbstractQuery

addCustomObjectField, addCustomSimpleField, appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

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

Method Detail

aggregations

public ProductsQuery aggregations(AggregationQueryDefinition queryDef)

Layered navigation aggregations.

filters

@Deprecated
public ProductsQuery filters(LayerFilterQueryDefinition queryDef)

Deprecated. Use aggregations instead

Layered navigation filters array.

items

public ProductsQuery items(ProductInterfaceQueryDefinition queryDef)

An array of products that match the specified search criteria.

pageInfo

public ProductsQuery pageInfo(SearchResultPageInfoQueryDefinition queryDef)

An object that includes the page_info and currentPage values specified in the query.

sortFields

public ProductsQuery sortFields(SortFieldsQueryDefinition queryDef)

An object that includes the default sort field and all available sort fields.

totalCount

public ProductsQuery totalCount()

The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.

createFragment

public static Fragment<ProductsQuery> createFragment(String name,
                                                     ProductsQueryDefinition queryDef)

Creates a GraphQL "named" fragment with the specified query type definition. The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.

Parameters:

name - The name of the fragment, must be unique for a given GraphQL request.

queryDef - The fragment definition.

Returns:

The fragment of a given generics type.

addFragmentReference

public ProductsQuery addFragmentReference(Fragment<ProductsQuery> fragment)

Adds a ProductsQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.

Parameters:

fragment - The fragment to reference.