CategoryTree (Magento GraphQL data models and query builders 9.1.0-magento242ee API)

java.lang.Object
- com.shopify.graphql.support.AbstractResponse<CategoryTree>
- - com.adobe.cq.commerce.magento.graphql.CategoryTree

All Implemented Interfaces:

CategoryInterface, CustomFieldInterface, Serializable
```
public class CategoryTree
extends AbstractResponse<CategoryTree>
implements CategoryInterface
```
Category Tree implementation.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractResponse
  optimisticData, responseData

Constructor Summary

Constructors
Constructor and Description

CategoryTree()

CategoryTree(com.google.gson.JsonObject fields)

Constructors
Constructor and Description
`CategoryTree()`
`CategoryTree(com.google.gson.JsonObject fields)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAutomaticSorting()`
`List<String>`	`getAvailableSortBy()`
`List<Breadcrumb>`	`getBreadcrumbs()` Breadcrumbs, parent categories info.
`String`	`getCanonicalUrl()` Relative canonical URL.
`List<CategoryTree>`	`getChildren()` Child categories tree.
`String`	`getChildrenCount()`
`CmsBlock`	`getCmsBlock()` Category CMS Block.
`String`	`getCreatedAt()` Deprecated. The field should not be used on the storefront.
`String`	`getCustomLayoutUpdateFile()`
`String`	`getDefaultSortBy()` The attribute to use for sorting.
`String`	`getDescription()` An optional description of the category.
`String`	`getDisplayMode()`
`Double`	`getFilterPriceRange()`
`String`	`getGraphQlTypeName()`
`Integer`	`getId()` Deprecated. Use the `uid` argument instead.
`String`	`getImage()`
`Integer`	`getIncludeInMenu()`
`Integer`	`getIsAnchor()`
`Integer`	`getLandingPage()`
`Integer`	`getLevel()` Indicates the depth of the category within the tree.
`String`	`getMetaDescription()`
`String`	`getMetaKeywords()`
`String`	`getMetaTitle()`
`String`	`getName()` The display name of the category.
`String`	`getPath()` Category Path.
`String`	`getPathInStore()` Category path in store.
`Integer`	`getPosition()` The position of the category relative to other categories at the same level in tree.
`Integer`	`getProductCount()` The number of products in the category that are marked as visible.
`CategoryProducts`	`getProducts()` The list of products assigned to the category.
`Boolean`	`getStaged()`
`ID`	`getUid()` The unique ID for a `CategoryInterface` object.
`String`	`getUpdatedAt()` Deprecated. The field should not be used on the storefront.
`String`	`getUrlKey()` The url key assigned to the category.
`String`	`getUrlPath()` The url path assigned to the category.
`String`	`getUrlSuffix()` The part of the category URL that is appended after the url key
`CategoryTree`	`setAutomaticSorting(String arg)`
`CategoryTree`	`setAvailableSortBy(List<String> arg)`
`CategoryTree`	`setBreadcrumbs(List<Breadcrumb> arg)`
`CategoryTree`	`setCanonicalUrl(String arg)`
`CategoryTree`	`setChildren(List<CategoryTree> arg)`
`CategoryTree`	`setChildrenCount(String arg)`
`CategoryTree`	`setCmsBlock(CmsBlock arg)`
`CategoryTree`	`setCreatedAt(String arg)`
`CategoryTree`	`setCustomLayoutUpdateFile(String arg)`
`CategoryTree`	`setDefaultSortBy(String arg)`
`CategoryTree`	`setDescription(String arg)`
`CategoryTree`	`setDisplayMode(String arg)`
`CategoryTree`	`setFilterPriceRange(Double arg)`
`CategoryTree`	`setId(Integer arg)`
`CategoryTree`	`setImage(String arg)`
`CategoryTree`	`setIncludeInMenu(Integer arg)`
`CategoryTree`	`setIsAnchor(Integer arg)`
`CategoryTree`	`setLandingPage(Integer arg)`
`CategoryTree`	`setLevel(Integer arg)`
`CategoryTree`	`setMetaDescription(String arg)`
`CategoryTree`	`setMetaKeywords(String arg)`
`CategoryTree`	`setMetaTitle(String arg)`
`CategoryTree`	`setName(String arg)`
`CategoryTree`	`setPath(String arg)`
`CategoryTree`	`setPathInStore(String arg)`
`CategoryTree`	`setPosition(Integer arg)`
`CategoryTree`	`setProductCount(Integer arg)`
`CategoryTree`	`setProducts(CategoryProducts arg)`
`CategoryTree`	`setStaged(Boolean arg)`
`CategoryTree`	`setUid(ID arg)`
`CategoryTree`	`setUpdatedAt(String arg)`
`CategoryTree`	`setUrlKey(String arg)`
`CategoryTree`	`setUrlPath(String arg)`
`CategoryTree`	`setUrlSuffix(String arg)`
`boolean`	`unwrapsToObject(String key)`

Methods inherited from class com.shopify.graphql.support.AbstractResponse
collectNodes, get, getAsArray, getAsBoolean, getAsDouble, getAsInteger, getAsString, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, readCustomField, withAlias

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.shopify.graphql.support.CustomFieldInterface
get, getAsArray, getAsBoolean, getAsDouble, getAsInteger, getAsString

- Constructor Detail
  - CategoryTree
```
public CategoryTree()
```
  - CategoryTree
```
public CategoryTree(com.google.gson.JsonObject fields)
             throws SchemaViolationError
```
    Throws:
    
    SchemaViolationError
- Method Detail
  - getGraphQlTypeName
```
public String getGraphQlTypeName()
```
    Specified by:
    
    getGraphQlTypeName in interface CategoryInterface
  - getAutomaticSorting
```
public String getAutomaticSorting()
```
    Specified by:
    
    getAutomaticSorting in interface CategoryInterface
  - setAutomaticSorting
```
public CategoryTree setAutomaticSorting(String arg)
```
  - getAvailableSortBy
```
public List<String> getAvailableSortBy()
```
    Specified by:
    
    getAvailableSortBy in interface CategoryInterface
  - setAvailableSortBy
```
public CategoryTree setAvailableSortBy(List<String> arg)
```
  - getBreadcrumbs
```
public List<Breadcrumb> getBreadcrumbs()
```
    Breadcrumbs, parent categories info.
    
    Specified by:
    
    getBreadcrumbs in interface CategoryInterface
  - setBreadcrumbs
```
public CategoryTree setBreadcrumbs(List<Breadcrumb> arg)
```
  - getCanonicalUrl
```
public String getCanonicalUrl()
```
    Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled
    
    Specified by:
    
    getCanonicalUrl in interface CategoryInterface
  - setCanonicalUrl
```
public CategoryTree setCanonicalUrl(String arg)
```
  - getChildren
```
public List<CategoryTree> getChildren()
```
    Child categories tree.
  - setChildren
```
public CategoryTree setChildren(List<CategoryTree> arg)
```
  - getChildrenCount
```
public String getChildrenCount()
```
    Specified by:
    
    getChildrenCount in interface CategoryInterface
  - setChildrenCount
```
public CategoryTree setChildrenCount(String arg)
```
  - getCmsBlock
```
public CmsBlock getCmsBlock()
```
    Category CMS Block.
    
    Specified by:
    
    getCmsBlock in interface CategoryInterface
  - setCmsBlock
```
public CategoryTree setCmsBlock(CmsBlock arg)
```
  - getCreatedAt
```
@Deprecated
public String getCreatedAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the category was created.
    
    Specified by:
    
    getCreatedAt in interface CategoryInterface
  - setCreatedAt
```
public CategoryTree setCreatedAt(String arg)
```
  - getCustomLayoutUpdateFile
```
public String getCustomLayoutUpdateFile()
```
    Specified by:
    
    getCustomLayoutUpdateFile in interface CategoryInterface
  - setCustomLayoutUpdateFile
```
public CategoryTree setCustomLayoutUpdateFile(String arg)
```
  - getDefaultSortBy
```
public String getDefaultSortBy()
```
    The attribute to use for sorting.
    
    Specified by:
    
    getDefaultSortBy in interface CategoryInterface
  - setDefaultSortBy
```
public CategoryTree setDefaultSortBy(String arg)
```
  - getDescription
```
public String getDescription()
```
    An optional description of the category.
    
    Specified by:
    
    getDescription in interface CategoryInterface
  - setDescription
```
public CategoryTree setDescription(String arg)
```
  - getDisplayMode
```
public String getDisplayMode()
```
    Specified by:
    
    getDisplayMode in interface CategoryInterface
  - setDisplayMode
```
public CategoryTree setDisplayMode(String arg)
```
  - getFilterPriceRange
```
public Double getFilterPriceRange()
```
    Specified by:
    
    getFilterPriceRange in interface CategoryInterface
  - setFilterPriceRange
```
public CategoryTree setFilterPriceRange(Double arg)
```
  - getId
```
@Deprecated
public Integer getId()
```
    Deprecated. Use the `uid` argument instead.
    
    An ID that uniquely identifies the category.
    
    Specified by:
    
    getId in interface CategoryInterface
  - setId
```
public CategoryTree setId(Integer arg)
```
  - getImage
```
public String getImage()
```
    Specified by:
    
    getImage in interface CategoryInterface
  - setImage
```
public CategoryTree setImage(String arg)
```
  - getIncludeInMenu
```
public Integer getIncludeInMenu()
```
    Specified by:
    
    getIncludeInMenu in interface CategoryInterface
  - setIncludeInMenu
```
public CategoryTree setIncludeInMenu(Integer arg)
```
  - getIsAnchor
```
public Integer getIsAnchor()
```
    Specified by:
    
    getIsAnchor in interface CategoryInterface
  - setIsAnchor
```
public CategoryTree setIsAnchor(Integer arg)
```
  - getLandingPage
```
public Integer getLandingPage()
```
    Specified by:
    
    getLandingPage in interface CategoryInterface
  - setLandingPage
```
public CategoryTree setLandingPage(Integer arg)
```
  - getLevel
```
public Integer getLevel()
```
    Indicates the depth of the category within the tree.
    
    Specified by:
    
    getLevel in interface CategoryInterface
  - setLevel
```
public CategoryTree setLevel(Integer arg)
```
  - getMetaDescription
```
public String getMetaDescription()
```
    Specified by:
    
    getMetaDescription in interface CategoryInterface
  - setMetaDescription
```
public CategoryTree setMetaDescription(String arg)
```
  - getMetaKeywords
```
public String getMetaKeywords()
```
    Specified by:
    
    getMetaKeywords in interface CategoryInterface
  - setMetaKeywords
```
public CategoryTree setMetaKeywords(String arg)
```
  - getMetaTitle
```
public String getMetaTitle()
```
    Specified by:
    
    getMetaTitle in interface CategoryInterface
  - setMetaTitle
```
public CategoryTree setMetaTitle(String arg)
```
  - getName
```
public String getName()
```
    The display name of the category.
    
    Specified by:
    
    getName in interface CategoryInterface
  - setName
```
public CategoryTree setName(String arg)
```
  - getPath
```
public String getPath()
```
    Category Path.
    
    Specified by:
    
    getPath in interface CategoryInterface
  - setPath
```
public CategoryTree setPath(String arg)
```
  - getPathInStore
```
public String getPathInStore()
```
    Category path in store.
    
    Specified by:
    
    getPathInStore in interface CategoryInterface
  - setPathInStore
```
public CategoryTree setPathInStore(String arg)
```
  - getPosition
```
public Integer getPosition()
```
    The position of the category relative to other categories at the same level in tree.
    
    Specified by:
    
    getPosition in interface CategoryInterface
  - setPosition
```
public CategoryTree setPosition(Integer arg)
```
  - getProductCount
```
public Integer getProductCount()
```
    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.
    
    Specified by:
    
    getProductCount in interface CategoryInterface
  - setProductCount
```
public CategoryTree setProductCount(Integer arg)
```
  - getProducts
```
public CategoryProducts getProducts()
```
    The list of products assigned to the category.
    
    Specified by:
    
    getProducts in interface CategoryInterface
  - setProducts
```
public CategoryTree setProducts(CategoryProducts arg)
```
  - getStaged
```
public Boolean getStaged()
```
    Specified by:
    
    getStaged in interface CategoryInterface
  - setStaged
```
public CategoryTree setStaged(Boolean arg)
```
  - getUid
```
public ID getUid()
```
    The unique ID for a `CategoryInterface` object.
    
    Specified by:
    
    getUid in interface CategoryInterface
  - setUid
```
public CategoryTree setUid(ID arg)
```
  - getUpdatedAt
```
@Deprecated
public String getUpdatedAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the category was updated.
    
    Specified by:
    
    getUpdatedAt in interface CategoryInterface
  - setUpdatedAt
```
public CategoryTree setUpdatedAt(String arg)
```
  - getUrlKey
```
public String getUrlKey()
```
    The url key assigned to the category.
    
    Specified by:
    
    getUrlKey in interface CategoryInterface
  - setUrlKey
```
public CategoryTree setUrlKey(String arg)
```
  - getUrlPath
```
public String getUrlPath()
```
    The url path assigned to the category.
    
    Specified by:
    
    getUrlPath in interface CategoryInterface
  - setUrlPath
```
public CategoryTree setUrlPath(String arg)
```
  - getUrlSuffix
```
public String getUrlSuffix()
```
    The part of the category URL that is appended after the url key
    
    Specified by:
    
    getUrlSuffix in interface CategoryInterface
  - setUrlSuffix
```
public CategoryTree setUrlSuffix(String arg)
```
  - unwrapsToObject
```
public boolean unwrapsToObject(String key)
```
    Specified by:
    
    unwrapsToObject in class AbstractResponse<CategoryTree>

Class CategoryTree

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractResponse

Constructor Summary

Method Summary

Methods inherited from class com.shopify.graphql.support.AbstractResponse

Methods inherited from class java.lang.Object

Methods inherited from interface com.shopify.graphql.support.CustomFieldInterface

Constructor Detail

CategoryTree

CategoryTree

Method Detail

getGraphQlTypeName

getAutomaticSorting

setAutomaticSorting

getAvailableSortBy

setAvailableSortBy

getBreadcrumbs

setBreadcrumbs

getCanonicalUrl

setCanonicalUrl

getChildren

setChildren

getChildrenCount

setChildrenCount

getCmsBlock

setCmsBlock

getCreatedAt

setCreatedAt

getCustomLayoutUpdateFile

setCustomLayoutUpdateFile

getDefaultSortBy

setDefaultSortBy

getDescription

setDescription

getDisplayMode

setDisplayMode

getFilterPriceRange

setFilterPriceRange

getId

setId

getImage

setImage

getIncludeInMenu

setIncludeInMenu

getIsAnchor

setIsAnchor

getLandingPage

setLandingPage

getLevel

setLevel

getMetaDescription

setMetaDescription

getMetaKeywords

setMetaKeywords

getMetaTitle

setMetaTitle

getName

setName

getPath

setPath

getPathInStore

setPathInStore

getPosition

setPosition

getProductCount

setProductCount

getProducts

setProducts

getStaged

setStaged

getUid

setUid

getUpdatedAt

setUpdatedAt

getUrlKey

setUrlKey

getUrlPath

setUrlPath

getUrlSuffix