com.adobe.cq.commerce.magento.graphql

Class QueryQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.QueryQuery

public class QueryQuery
extends AbstractQuery<QueryQuery>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	QueryQuery.AvailableStoresArguments
static interface	QueryQuery.AvailableStoresArgumentsDefinition
class	QueryQuery.CategoriesArguments
static interface	QueryQuery.CategoriesArgumentsDefinition
class	QueryQuery.CategoryArguments
static interface	QueryQuery.CategoryArgumentsDefinition
class	QueryQuery.CategoryListArguments
static interface	QueryQuery.CategoryListArgumentsDefinition
class	QueryQuery.CmsBlocksArguments
static interface	QueryQuery.CmsBlocksArgumentsDefinition
class	QueryQuery.CmsPageArguments
static interface	QueryQuery.CmsPageArgumentsDefinition
class	QueryQuery.CountryArguments
static interface	QueryQuery.CountryArgumentsDefinition
class	QueryQuery.PickupLocationsArguments
static interface	QueryQuery.PickupLocationsArgumentsDefinition
class	QueryQuery.ProductsArguments
static interface	QueryQuery.ProductsArgumentsDefinition

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
QueryQuery	__schema(__SchemaQueryDefinition queryDef) The root __schema field for introspection queries.
QueryQuery	__type(String name, __TypeQueryDefinition queryDef) The root __type field for introspection queries.
QueryQuery	addFragment(Fragment fragment) Adds a GraphQL "named" fragment to the query.
QueryQuery	addFragmentReference(Fragment<QueryQuery> fragment) Adds a QueryQuery fragment reference at the current position of the query.
QueryQuery	availableStores(QueryQuery.AvailableStoresArgumentsDefinition argsDef, StoreConfigQueryDefinition queryDef) Get a list of available store views and their config information.
QueryQuery	availableStores(StoreConfigQueryDefinition queryDef) Get a list of available store views and their config information.
QueryQuery	cart(String cartId, CartQueryDefinition queryDef) Returns information about shopping cart
QueryQuery	categories(CategoryResultQueryDefinition queryDef)
QueryQuery	categories(QueryQuery.CategoriesArgumentsDefinition argsDef, CategoryResultQueryDefinition queryDef)
QueryQuery	category(CategoryTreeQueryDefinition queryDef) Deprecated. Use 'categoryList' query instead of 'category' query
QueryQuery	category(QueryQuery.CategoryArgumentsDefinition argsDef, CategoryTreeQueryDefinition queryDef) Deprecated. Use 'categoryList' query instead of 'category' query
QueryQuery	categoryList(CategoryTreeQueryDefinition queryDef) Returns an array of categories based on the specified filters.
QueryQuery	categoryList(QueryQuery.CategoryListArgumentsDefinition argsDef, CategoryTreeQueryDefinition queryDef) Returns an array of categories based on the specified filters.
QueryQuery	checkoutAgreements(CheckoutAgreementQueryDefinition queryDef) The Checkout Agreements information
QueryQuery	cmsBlocks(CmsBlocksQueryDefinition queryDef) The CMS block query returns information about CMS blocks
QueryQuery	cmsBlocks(QueryQuery.CmsBlocksArgumentsDefinition argsDef, CmsBlocksQueryDefinition queryDef) The CMS block query returns information about CMS blocks
QueryQuery	cmsPage(CmsPageQueryDefinition queryDef) The CMS page query returns information about a CMS page
QueryQuery	cmsPage(QueryQuery.CmsPageArgumentsDefinition argsDef, CmsPageQueryDefinition queryDef) The CMS page query returns information about a CMS page
QueryQuery	compareList(ID uid, CompareListQueryDefinition queryDef) Return products that have been added to the specified compare list
QueryQuery	countries(CountryQueryDefinition queryDef) The countries query provides information for all countries.
QueryQuery	country(CountryQueryDefinition queryDef) The countries query provides information for a single country.
QueryQuery	country(QueryQuery.CountryArgumentsDefinition argsDef, CountryQueryDefinition queryDef) The countries query provides information for a single country.
static Fragment<QueryQuery>	createFragment(String name, QueryQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
QueryQuery	currency(CurrencyQueryDefinition queryDef) The currency query returns information about store currency.
QueryQuery	customAttributeMetadata(List<AttributeInput> attributes, CustomAttributeMetadataQueryDefinition queryDef) The customAttributeMetadata query returns the attribute type, given an attribute code and entity type
QueryQuery	customer(CustomerQueryDefinition queryDef) The customer query returns information about a customer account
QueryQuery	customerCart(CartQueryDefinition queryDef) Returns information about the customer shopping cart
QueryQuery	customerDownloadableProducts(CustomerDownloadableProductsQueryDefinition queryDef) The query returns the contents of a customer's downloadable products
QueryQuery	customerOrders(CustomerOrdersQueryDefinition queryDef) Deprecated. Use orders from customer instead
QueryQuery	customerPaymentTokens(CustomerPaymentTokensQueryDefinition queryDef) Return a list of customer payment tokens
QueryQuery	getHostedProUrl(HostedProUrlInput input, HostedProUrlQueryDefinition queryDef) Retrieve secure PayPal url for Payments Pro Hosted Solution transaction.
QueryQuery	getPayflowLinkToken(PayflowLinkTokenInput input, PayflowLinkTokenQueryDefinition queryDef) Retrieve payment credentials for transaction.
QueryQuery	giftCardAccount(GiftCardAccountInput input, GiftCardAccountQueryDefinition queryDef) Get information for gift card account by code
QueryQuery	isEmailAvailable(String email, IsEmailAvailableOutputQueryDefinition queryDef)
QueryQuery	pickupLocations(PickupLocationsQueryDefinition queryDef) The pickup locations query searches for locations that match the search request requirements.
QueryQuery	pickupLocations(QueryQuery.PickupLocationsArgumentsDefinition argsDef, PickupLocationsQueryDefinition queryDef) The pickup locations query searches for locations that match the search request requirements.
QueryQuery	productReviewRatingsMetadata(ProductReviewRatingsMetadataQueryDefinition queryDef) Retrieves metadata required by clients to render the Reviews section.
QueryQuery	products(ProductsQueryDefinition queryDef) The products query searches for products that match the criteria specified in the search and filter attributes.
QueryQuery	products(QueryQuery.ProductsArgumentsDefinition argsDef, ProductsQueryDefinition queryDef) The products query searches for products that match the criteria specified in the search and filter attributes.
QueryQuery	storeConfig(StoreConfigQueryDefinition queryDef) The store config query
String	toString()
QueryQuery	urlResolver(String url, EntityUrlQueryDefinition queryDef) The urlResolver query returns the relative URL for a specified product, category or CMS page, using as input a url_key appended by the url_suffix, if one exists
QueryQuery	wishlist(WishlistOutputQueryDefinition queryDef) Deprecated. Moved under `Customer` `wishlist`

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, wait, wait, wait

Method Detail

availableStores

public QueryQuery availableStores(StoreConfigQueryDefinition queryDef)

Get a list of available store views and their config information.

availableStores

public QueryQuery availableStores(QueryQuery.AvailableStoresArgumentsDefinition argsDef,
                                  StoreConfigQueryDefinition queryDef)

Get a list of available store views and their config information.

cart

public QueryQuery cart(String cartId,
                       CartQueryDefinition queryDef)

Returns information about shopping cart

categories

public QueryQuery categories(CategoryResultQueryDefinition queryDef)

categories

public QueryQuery categories(QueryQuery.CategoriesArgumentsDefinition argsDef,
                             CategoryResultQueryDefinition queryDef)

category

public QueryQuery category(CategoryTreeQueryDefinition queryDef)

Deprecated. Use 'categoryList' query instead of 'category' query

The category query searches for categories that match the criteria specified in the search and filter attributes.

category

@Deprecated
public QueryQuery category(QueryQuery.CategoryArgumentsDefinition argsDef,
                                       CategoryTreeQueryDefinition queryDef)

Deprecated. Use 'categoryList' query instead of 'category' query

The category query searches for categories that match the criteria specified in the search and filter attributes.

categoryList

public QueryQuery categoryList(CategoryTreeQueryDefinition queryDef)

Returns an array of categories based on the specified filters.

categoryList

public QueryQuery categoryList(QueryQuery.CategoryListArgumentsDefinition argsDef,
                               CategoryTreeQueryDefinition queryDef)

Returns an array of categories based on the specified filters.

checkoutAgreements

public QueryQuery checkoutAgreements(CheckoutAgreementQueryDefinition queryDef)

The Checkout Agreements information

cmsBlocks

public QueryQuery cmsBlocks(CmsBlocksQueryDefinition queryDef)

The CMS block query returns information about CMS blocks

cmsBlocks

public QueryQuery cmsBlocks(QueryQuery.CmsBlocksArgumentsDefinition argsDef,
                            CmsBlocksQueryDefinition queryDef)

The CMS block query returns information about CMS blocks

cmsPage

public QueryQuery cmsPage(CmsPageQueryDefinition queryDef)

The CMS page query returns information about a CMS page

cmsPage

public QueryQuery cmsPage(QueryQuery.CmsPageArgumentsDefinition argsDef,
                          CmsPageQueryDefinition queryDef)

The CMS page query returns information about a CMS page

compareList

public QueryQuery compareList(ID uid,
                              CompareListQueryDefinition queryDef)

Return products that have been added to the specified compare list

countries

public QueryQuery countries(CountryQueryDefinition queryDef)

The countries query provides information for all countries.

country

public QueryQuery country(CountryQueryDefinition queryDef)

The countries query provides information for a single country.

country

public QueryQuery country(QueryQuery.CountryArgumentsDefinition argsDef,
                          CountryQueryDefinition queryDef)

The countries query provides information for a single country.

currency

public QueryQuery currency(CurrencyQueryDefinition queryDef)

The currency query returns information about store currency.

customAttributeMetadata

public QueryQuery customAttributeMetadata(List<AttributeInput> attributes,
                                          CustomAttributeMetadataQueryDefinition queryDef)

The customAttributeMetadata query returns the attribute type, given an attribute code and entity type

customer

public QueryQuery customer(CustomerQueryDefinition queryDef)

The customer query returns information about a customer account

customerCart

public QueryQuery customerCart(CartQueryDefinition queryDef)

Returns information about the customer shopping cart

customerDownloadableProducts

public QueryQuery customerDownloadableProducts(CustomerDownloadableProductsQueryDefinition queryDef)

The query returns the contents of a customer's downloadable products

customerOrders

@Deprecated
public QueryQuery customerOrders(CustomerOrdersQueryDefinition queryDef)

Deprecated. Use orders from customer instead

customerPaymentTokens

public QueryQuery customerPaymentTokens(CustomerPaymentTokensQueryDefinition queryDef)

Return a list of customer payment tokens

getHostedProUrl

public QueryQuery getHostedProUrl(HostedProUrlInput input,
                                  HostedProUrlQueryDefinition queryDef)

Retrieve secure PayPal url for Payments Pro Hosted Solution transaction.

getPayflowLinkToken

public QueryQuery getPayflowLinkToken(PayflowLinkTokenInput input,
                                      PayflowLinkTokenQueryDefinition queryDef)

Retrieve payment credentials for transaction. Use this query for Payflow Link and Payments Advanced payment methods.

giftCardAccount

public QueryQuery giftCardAccount(GiftCardAccountInput input,
                                  GiftCardAccountQueryDefinition queryDef)

Get information for gift card account by code

isEmailAvailable

public QueryQuery isEmailAvailable(String email,
                                   IsEmailAvailableOutputQueryDefinition queryDef)

pickupLocations

public QueryQuery pickupLocations(PickupLocationsQueryDefinition queryDef)

The pickup locations query searches for locations that match the search request requirements.

pickupLocations

public QueryQuery pickupLocations(QueryQuery.PickupLocationsArgumentsDefinition argsDef,
                                  PickupLocationsQueryDefinition queryDef)

The pickup locations query searches for locations that match the search request requirements.

productReviewRatingsMetadata

public QueryQuery productReviewRatingsMetadata(ProductReviewRatingsMetadataQueryDefinition queryDef)

Retrieves metadata required by clients to render the Reviews section.

products

public QueryQuery products(ProductsQueryDefinition queryDef)

The products query searches for products that match the criteria specified in the search and filter attributes.

products

public QueryQuery products(QueryQuery.ProductsArgumentsDefinition argsDef,
                           ProductsQueryDefinition queryDef)

The products query searches for products that match the criteria specified in the search and filter attributes.

storeConfig

public QueryQuery storeConfig(StoreConfigQueryDefinition queryDef)

The store config query

urlResolver

public QueryQuery urlResolver(String url,
                              EntityUrlQueryDefinition queryDef)

The urlResolver query returns the relative URL for a specified product, category or CMS page, using as input a url_key appended by the url_suffix, if one exists

wishlist

@Deprecated
public QueryQuery wishlist(WishlistOutputQueryDefinition queryDef)

Deprecated. Moved under `Customer` `wishlist`

The wishlist query returns the contents of a customer's wish list

toString

public String toString()

Overrides:

toString in class Object

addFragment

public QueryQuery addFragment(Fragment fragment)

Adds a GraphQL "named" fragment to the query. If a fragment with the same name is already added, calling this method will replace the existing fragment.

Parameters:

fragment - The fragment to add.

__schema

public QueryQuery __schema(__SchemaQueryDefinition queryDef)

The root __schema field for introspection queries.

__type

public QueryQuery __type(String name,
                         __TypeQueryDefinition queryDef)

The root __type field for introspection queries.

createFragment

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

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