com.adobe.cq.commerce.magento.graphql

Class ReturnsQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.ReturnsQuery

public class ReturnsQuery
extends AbstractQuery<ReturnsQuery>

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
ReturnsQuery	addFragmentReference(Fragment<ReturnsQuery> fragment) Adds a ReturnsQuery fragment reference at the current position of the query.
static Fragment<ReturnsQuery>	createFragment(String name, ReturnsQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
ReturnsQuery	items(ReturnQueryDefinition queryDef) A list of return requests
ReturnsQuery	pageInfo(SearchResultPageInfoQueryDefinition queryDef) Pagination metadata
ReturnsQuery	totalCount() The total number of return requests

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 ReturnsQuery items(ReturnQueryDefinition queryDef)

A list of return requests

pageInfo

public ReturnsQuery pageInfo(SearchResultPageInfoQueryDefinition queryDef)

Pagination metadata

totalCount

public ReturnsQuery totalCount()

The total number of return requests

createFragment

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

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