com.adobe.cq.commerce.magento.graphql

Class CategoryResultQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.CategoryResultQuery

public class CategoryResultQuery
extends AbstractQuery<CategoryResultQuery>

A collection of CategoryTree objects and pagination information.

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
CategoryResultQuery	addFragmentReference(Fragment<CategoryResultQuery> fragment) Adds a CategoryResultQuery fragment reference at the current position of the query.
static Fragment<CategoryResultQuery>	createFragment(String name, CategoryResultQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
CategoryResultQuery	items(CategoryTreeQueryDefinition queryDef) A list of categories that match the filter criteria.
CategoryResultQuery	pageInfo(SearchResultPageInfoQueryDefinition queryDef) An object that includes the page_info and currentPage values specified in the query.
CategoryResultQuery	totalCount() The total number of categories that match the criteria.

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 CategoryResultQuery items(CategoryTreeQueryDefinition queryDef)

A list of categories that match the filter criteria.

pageInfo

public CategoryResultQuery pageInfo(SearchResultPageInfoQueryDefinition queryDef)

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

totalCount

public CategoryResultQuery totalCount()

The total number of categories that match the criteria.

createFragment

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

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