com.adobe.cq.commerce.magento.graphql

Class CategoryProductsQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.CategoryProductsQuery

public class CategoryProductsQuery
extends AbstractQuery<CategoryProductsQuery>

The category products object returned in the Category query.

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
CategoryProductsQuery	addFragmentReference(Fragment<CategoryProductsQuery> fragment) Adds a CategoryProductsQuery fragment reference at the current position of the query.
static Fragment<CategoryProductsQuery>	createFragment(String name, CategoryProductsQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
CategoryProductsQuery	items(ProductInterfaceQueryDefinition queryDef) An array of products that are assigned to the category.
CategoryProductsQuery	pageInfo(SearchResultPageInfoQueryDefinition queryDef) An object that includes the page_info and currentPage values specified in the query.
CategoryProductsQuery	totalCount() The number of products in the category 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

items

public CategoryProductsQuery items(ProductInterfaceQueryDefinition queryDef)

An array of products that are assigned to the category.

pageInfo

public CategoryProductsQuery pageInfo(SearchResultPageInfoQueryDefinition queryDef)

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

totalCount

public CategoryProductsQuery totalCount()

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

createFragment

public static Fragment<CategoryProductsQuery> createFragment(String name,
                                                             CategoryProductsQueryDefinition 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 CategoryProductsQuery addFragmentReference(Fragment<CategoryProductsQuery> fragment)

Adds a CategoryProductsQuery 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.