com.adobe.cq.commerce.magento.graphql

Class AggregationQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.AggregationQuery

public class AggregationQuery
extends AbstractQuery<AggregationQuery>

A bucket that contains information for each filterable option (such as price, category `UID`, and custom attributes).

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
AggregationQuery	addFragmentReference(Fragment<AggregationQuery> fragment) Adds a AggregationQuery fragment reference at the current position of the query.
AggregationQuery	attributeCode() Attribute code of the aggregation group.
AggregationQuery	count() The number of options in the aggregation group.
static Fragment<AggregationQuery>	createFragment(String name, AggregationQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
AggregationQuery	label() The aggregation display name.
AggregationQuery	options(AggregationOptionQueryDefinition queryDef) Array of options for the aggregation.

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

attributeCode

public AggregationQuery attributeCode()

Attribute code of the aggregation group.

count

public AggregationQuery count()

The number of options in the aggregation group.

label

public AggregationQuery label()

The aggregation display name.

options

public AggregationQuery options(AggregationOptionQueryDefinition queryDef)

Array of options for the aggregation.

createFragment

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

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