com.adobe.cq.commerce.magento.graphql

Class CreditMemoQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.CreditMemoQuery

public class CreditMemoQuery
extends AbstractQuery<CreditMemoQuery>

Credit memo details

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
CreditMemoQuery	addFragmentReference(Fragment<CreditMemoQuery> fragment) Adds a CreditMemoQuery fragment reference at the current position of the query.
CreditMemoQuery	comments(SalesCommentItemQueryDefinition queryDef) Comments on the credit memo
static Fragment<CreditMemoQuery>	createFragment(String name, CreditMemoQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
CreditMemoQuery	id() The unique ID for a `CreditMemo` object
CreditMemoQuery	items(CreditMemoItemInterfaceQueryDefinition queryDef) An array containing details about refunded items
CreditMemoQuery	number() The sequential credit memo number
CreditMemoQuery	total(CreditMemoTotalQueryDefinition queryDef) Contains details about the total refunded amount

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

comments

public CreditMemoQuery comments(SalesCommentItemQueryDefinition queryDef)

Comments on the credit memo

id

public CreditMemoQuery id()

The unique ID for a `CreditMemo` object

items

public CreditMemoQuery items(CreditMemoItemInterfaceQueryDefinition queryDef)

An array containing details about refunded items

number

public CreditMemoQuery number()

The sequential credit memo number

total

public CreditMemoQuery total(CreditMemoTotalQueryDefinition queryDef)

Contains details about the total refunded amount

createFragment

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

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