com.adobe.cq.commerce.magento.graphql

Class CategoryInterfaceQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.CategoryInterfaceQuery

public class CategoryInterfaceQuery
extends AbstractQuery<CategoryInterfaceQuery>

CategoryInterface contains the full set of attributes that can be returned in a category search.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CategoryInterfaceQuery.ProductsArguments
static interface	CategoryInterfaceQuery.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
CategoryInterfaceQuery	addFragmentReference(Fragment<CategoryInterfaceQuery> fragment) Adds a CategoryInterfaceQuery fragment reference at the current position of the query.
CategoryInterfaceQuery	automaticSorting()
CategoryInterfaceQuery	availableSortBy()
CategoryInterfaceQuery	breadcrumbs(BreadcrumbQueryDefinition queryDef) Breadcrumbs, parent categories info.
CategoryInterfaceQuery	canonicalUrl() Relative canonical URL.
CategoryInterfaceQuery	childrenCount()
CategoryInterfaceQuery	cmsBlock(CmsBlockQueryDefinition queryDef) Category CMS Block.
CategoryInterfaceQuery	createdAt() Deprecated. The field should not be used on the storefront.
static Fragment<CategoryInterfaceQuery>	createFragment(String name, CategoryInterfaceQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
CategoryInterfaceQuery	customLayoutUpdateFile()
CategoryInterfaceQuery	defaultSortBy() The attribute to use for sorting.
CategoryInterfaceQuery	description() An optional description of the category.
CategoryInterfaceQuery	displayMode()
CategoryInterfaceQuery	filterPriceRange()
CategoryInterfaceQuery	id() Deprecated. Use the `uid` argument instead.
CategoryInterfaceQuery	image()
CategoryInterfaceQuery	includeInMenu()
CategoryInterfaceQuery	isAnchor()
CategoryInterfaceQuery	landingPage()
CategoryInterfaceQuery	level() Indicates the depth of the category within the tree.
CategoryInterfaceQuery	metaDescription()
CategoryInterfaceQuery	metaKeywords()
CategoryInterfaceQuery	metaTitle()
CategoryInterfaceQuery	name() The display name of the category.
CategoryInterfaceQuery	onCategoryTree(CategoryTreeQueryDefinition queryDef)
CategoryInterfaceQuery	path() Category Path.
CategoryInterfaceQuery	pathInStore() Category path in store.
CategoryInterfaceQuery	position() The position of the category relative to other categories at the same level in tree.
CategoryInterfaceQuery	productCount() The number of products in the category that are marked as visible.
CategoryInterfaceQuery	products(CategoryInterfaceQuery.ProductsArgumentsDefinition argsDef, CategoryProductsQueryDefinition queryDef) The list of products assigned to the category.
CategoryInterfaceQuery	products(CategoryProductsQueryDefinition queryDef) The list of products assigned to the category.
CategoryInterfaceQuery	staged()
CategoryInterfaceQuery	uid() The unique ID for a `CategoryInterface` object.
CategoryInterfaceQuery	updatedAt() Deprecated. The field should not be used on the storefront.
CategoryInterfaceQuery	urlKey() The url key assigned to the category.
CategoryInterfaceQuery	urlPath() The url path assigned to the category.
CategoryInterfaceQuery	urlSuffix() The part of the category URL that is appended after the url key

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

automaticSorting

public CategoryInterfaceQuery automaticSorting()

availableSortBy

public CategoryInterfaceQuery availableSortBy()

breadcrumbs

public CategoryInterfaceQuery breadcrumbs(BreadcrumbQueryDefinition queryDef)

Breadcrumbs, parent categories info.

canonicalUrl

public CategoryInterfaceQuery canonicalUrl()

Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled

childrenCount

public CategoryInterfaceQuery childrenCount()

cmsBlock

public CategoryInterfaceQuery cmsBlock(CmsBlockQueryDefinition queryDef)

Category CMS Block.

createdAt

@Deprecated
public CategoryInterfaceQuery createdAt()

Deprecated. The field should not be used on the storefront.

Timestamp indicating when the category was created.

customLayoutUpdateFile

public CategoryInterfaceQuery customLayoutUpdateFile()

defaultSortBy

public CategoryInterfaceQuery defaultSortBy()

The attribute to use for sorting.

description

public CategoryInterfaceQuery description()

An optional description of the category.

displayMode

public CategoryInterfaceQuery displayMode()

filterPriceRange

public CategoryInterfaceQuery filterPriceRange()

id

@Deprecated
public CategoryInterfaceQuery id()

Deprecated. Use the `uid` argument instead.

An ID that uniquely identifies the category.

image

public CategoryInterfaceQuery image()

includeInMenu

public CategoryInterfaceQuery includeInMenu()

isAnchor

public CategoryInterfaceQuery isAnchor()

landingPage

public CategoryInterfaceQuery landingPage()

level

public CategoryInterfaceQuery level()

Indicates the depth of the category within the tree.

metaDescription

public CategoryInterfaceQuery metaDescription()

metaKeywords

public CategoryInterfaceQuery metaKeywords()

metaTitle

public CategoryInterfaceQuery metaTitle()

name

public CategoryInterfaceQuery name()

The display name of the category.

path

public CategoryInterfaceQuery path()

Category Path.

pathInStore

public CategoryInterfaceQuery pathInStore()

Category path in store.

position

public CategoryInterfaceQuery position()

The position of the category relative to other categories at the same level in tree.

productCount

public CategoryInterfaceQuery productCount()

The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.

products

public CategoryInterfaceQuery products(CategoryProductsQueryDefinition queryDef)

The list of products assigned to the category.

products

public CategoryInterfaceQuery products(CategoryInterfaceQuery.ProductsArgumentsDefinition argsDef,
                                       CategoryProductsQueryDefinition queryDef)

The list of products assigned to the category.

staged

public CategoryInterfaceQuery staged()

uid

public CategoryInterfaceQuery uid()

The unique ID for a `CategoryInterface` object.

updatedAt

@Deprecated
public CategoryInterfaceQuery updatedAt()

Deprecated. The field should not be used on the storefront.

Timestamp indicating when the category was updated.

urlKey

public CategoryInterfaceQuery urlKey()

The url key assigned to the category.

urlPath

public CategoryInterfaceQuery urlPath()

The url path assigned to the category.

urlSuffix

public CategoryInterfaceQuery urlSuffix()

The part of the category URL that is appended after the url key

onCategoryTree

public CategoryInterfaceQuery onCategoryTree(CategoryTreeQueryDefinition queryDef)

createFragment

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

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