A B C D E F G H I L M N O P Q R S T U V 
All Classes All Packages

A

AbstractCategoriesRetriever - Class in com.adobe.cq.commerce.core.components.models.retriever
 
AbstractCategoriesRetriever(MagentoGraphqlClient) - Constructor for class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
 
AbstractCategoryRetriever - Class in com.adobe.cq.commerce.core.components.models.retriever
 
AbstractCategoryRetriever(MagentoGraphqlClient) - Constructor for class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
 
AbstractProductRetriever - Class in com.adobe.cq.commerce.core.components.models.retriever
Abstract implementation of product retriever that loads product data using GraphQL.
AbstractProductRetriever(MagentoGraphqlClient) - Constructor for class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
 
AbstractProductsRetriever - Class in com.adobe.cq.commerce.core.components.models.retriever
 
AbstractProductsRetriever(MagentoGraphqlClient) - Constructor for class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
 
AbstractRetriever - Class in com.adobe.cq.commerce.core.components.models.retriever
Abstract implementation of retriever that fetches data using GraphQL.
AbstractRetriever(MagentoGraphqlClient) - Constructor for class com.adobe.cq.commerce.core.components.models.retriever.AbstractRetriever
 
ACTIONS_SECTION - Static variable in interface com.adobe.cq.commerce.core.components.models.product.Product
 
addSorterKey(String, String, Sorter.Order) - Method in interface com.adobe.cq.commerce.core.search.models.SearchOptions
Add a possible sorter key to this search options.
ASC - com.adobe.cq.commerce.core.components.storefrontcontext.SortDirection
 
ASC - com.adobe.cq.commerce.core.search.models.Sorter.Order
 
asJson() - Method in interface com.adobe.cq.commerce.core.components.models.product.Asset
 
asMap() - Method in class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
Deprecated.
asMap() - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
Deprecated.
Asset - Interface in com.adobe.cq.commerce.core.components.models.product
Asset is a view model interface representing a product asset.

B

Breadcrumb - Interface in com.adobe.cq.commerce.core.components.models.breadcrumb
 

C

categories - com.adobe.cq.commerce.core.components.storefrontcontext.QueryType
 
categories - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
List of category instances.
category - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Category instance.
CATEGORY - com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier.EntityType
 
CATEGORY_IMAGE_FOLDER - Static variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
 
CATEGORY_PAGE_URL_FORMAT - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlFormat
Deprecated.
The value of the UrlFormat.PROP_USE_AS property to be set when the UrlFormat should be used to format and parse category urls.
CategoryData - Interface in com.adobe.cq.commerce.core.components.datalayer
 
categoryFilterHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
Lambda that allows to replace or extend the category filters.
categoryFilterHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Lambda that allows to replace or extend the category filters.
CategoryListData - Interface in com.adobe.cq.commerce.core.components.datalayer
 
categoryQueryHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
Lambda that extends the category query.
categoryQueryHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Lambda that extends the category query.
CategoryStorefrontContext - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
 
CategoryUrlFormat - Interface in com.adobe.cq.commerce.core.components.services.urls
This interface represents a specific implementation of the GenericUrlFormat for category urls.
CategoryUrlFormat.Params - Class in com.adobe.cq.commerce.core.components.services.urls
Instances of this class hold the parameters used by implementations of the CategoryUrlFormat.
client - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractRetriever
Instance of the Magento GraphQL client.
CLOSING_BRACKETS - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlFormat
Deprecated.
A CharSequence to be used to write defaults to the format when a mandatory parameter is missing.
COLOR - com.adobe.cq.commerce.core.components.models.product.VariantValue.SwatchType
 
com.adobe.cq.commerce.core.components.client - package com.adobe.cq.commerce.core.components.client
 
com.adobe.cq.commerce.core.components.datalayer - package com.adobe.cq.commerce.core.components.datalayer
 
com.adobe.cq.commerce.core.components.models - package com.adobe.cq.commerce.core.components.models
 
com.adobe.cq.commerce.core.components.models.account - package com.adobe.cq.commerce.core.components.models.account
 
com.adobe.cq.commerce.core.components.models.breadcrumb - package com.adobe.cq.commerce.core.components.models.breadcrumb
 
com.adobe.cq.commerce.core.components.models.categorylist - package com.adobe.cq.commerce.core.components.models.categorylist
 
com.adobe.cq.commerce.core.components.models.common - package com.adobe.cq.commerce.core.components.models.common
 
com.adobe.cq.commerce.core.components.models.contentfragment - package com.adobe.cq.commerce.core.components.models.contentfragment
 
com.adobe.cq.commerce.core.components.models.experiencefragment - package com.adobe.cq.commerce.core.components.models.experiencefragment
 
com.adobe.cq.commerce.core.components.models.header - package com.adobe.cq.commerce.core.components.models.header
 
com.adobe.cq.commerce.core.components.models.navigation - package com.adobe.cq.commerce.core.components.models.navigation
 
com.adobe.cq.commerce.core.components.models.page - package com.adobe.cq.commerce.core.components.models.page
 
com.adobe.cq.commerce.core.components.models.product - package com.adobe.cq.commerce.core.components.models.product
 
com.adobe.cq.commerce.core.components.models.productcarousel - package com.adobe.cq.commerce.core.components.models.productcarousel
 
com.adobe.cq.commerce.core.components.models.productcollection - package com.adobe.cq.commerce.core.components.models.productcollection
 
com.adobe.cq.commerce.core.components.models.productlist - package com.adobe.cq.commerce.core.components.models.productlist
 
com.adobe.cq.commerce.core.components.models.productteaser - package com.adobe.cq.commerce.core.components.models.productteaser
 
com.adobe.cq.commerce.core.components.models.retriever - package com.adobe.cq.commerce.core.components.models.retriever
 
com.adobe.cq.commerce.core.components.models.searchbar - package com.adobe.cq.commerce.core.components.models.searchbar
 
com.adobe.cq.commerce.core.components.models.searchresults - package com.adobe.cq.commerce.core.components.models.searchresults
 
com.adobe.cq.commerce.core.components.models.storeconfigexporter - package com.adobe.cq.commerce.core.components.models.storeconfigexporter
 
com.adobe.cq.commerce.core.components.models.teaser - package com.adobe.cq.commerce.core.components.models.teaser
 
com.adobe.cq.commerce.core.components.services - package com.adobe.cq.commerce.core.components.services
 
com.adobe.cq.commerce.core.components.services.sitemap - package com.adobe.cq.commerce.core.components.services.sitemap
 
com.adobe.cq.commerce.core.components.services.urls - package com.adobe.cq.commerce.core.components.services.urls
 
com.adobe.cq.commerce.core.components.storefrontcontext - package com.adobe.cq.commerce.core.components.storefrontcontext
 
com.adobe.cq.commerce.core.components.utils - package com.adobe.cq.commerce.core.components.utils
 
com.adobe.cq.commerce.core.search.models - package com.adobe.cq.commerce.core.search.models
 
com.adobe.cq.commerce.core.search.services - package com.adobe.cq.commerce.core.search.services
 
CombinedSku - Class in com.adobe.cq.commerce.core.components.models.common
This class represents a combined sku.
CombinedSku(String, String) - Constructor for class com.adobe.cq.commerce.core.components.models.common.CombinedSku
 
CommerceContentFragment - Interface in com.adobe.cq.commerce.core.components.models.contentfragment
Sling model for the Commerce Content Fragment component.
CommerceExperienceFragment - Interface in com.adobe.cq.commerce.core.components.models.experiencefragment
 
CommerceExperienceFragmentContainer - Interface in com.adobe.cq.commerce.core.components.models.experiencefragment
Interface for an Experience Fragment container to be used in a ProductList
CommerceIdentifier - Interface in com.adobe.cq.commerce.core.components.models.common
An identifier for any commerce entity (category or product).
CommerceIdentifier.EntityType - Enum in com.adobe.cq.commerce.core.components.models.common
The type of the entity which is identified
CommerceIdentifier.IdentifierType - Enum in com.adobe.cq.commerce.core.components.models.common
The type of this identifier
CommerceStorefrontContext - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
 
CommerceTeaser - Interface in com.adobe.cq.commerce.core.components.models.teaser
 
CommerceTeaserActionItem - Interface in com.adobe.cq.commerce.core.components.models.teaser
 
ComponentsConfiguration - Class in com.adobe.cq.commerce.core.components.services
Simple POJO to store the configuration properties
ComponentsConfiguration(ValueMap) - Constructor for class com.adobe.cq.commerce.core.components.services.ComponentsConfiguration
Creates an object of this type.
CONFIGURATION_NAME - Static variable in interface com.adobe.cq.commerce.core.components.client.MagentoGraphqlClient
 
currentPage - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Current page for pagination of products in a category.

D

DeniedHttpHeaders - Interface in com.adobe.cq.commerce.core.components.client
 
DENYLIST - Static variable in interface com.adobe.cq.commerce.core.components.client.DeniedHttpHeaders
A list of HTTP headers that cannot be overridden when configuring a list of custom HTTP headers
DESC - com.adobe.cq.commerce.core.components.storefrontcontext.SortDirection
 
DESC - com.adobe.cq.commerce.core.search.models.Sorter.Order
 
DESCRIPTION_SECTION - Static variable in interface com.adobe.cq.commerce.core.components.models.product.Product
 
DETAILS_SECTION - Static variable in interface com.adobe.cq.commerce.core.components.models.product.Product
 

E

EMPTY - Static variable in class com.adobe.cq.commerce.core.components.services.ComponentsConfiguration
 
execute(String) - Method in interface com.adobe.cq.commerce.core.components.client.MagentoGraphqlClient
Executes the given Magento query and returns the response.
execute(String, HttpMethod) - Method in interface com.adobe.cq.commerce.core.components.client.MagentoGraphqlClient
Executes the given Magento query and returns the response.
executeQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
Execute the GraphQL query with the GraphQL client.
executeQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Execute the GraphQL query with the GraphQL client.
executeQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Execute the GraphQL query with the GraphQL client.
executeQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Execute the GraphQL query with the GraphQL client.
executeQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractRetriever
Execute the GraphQL query with the GraphQL client.
extendCategoryFilterWith(Function<CategoryFilterInput, CategoryFilterInput>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
Extends or replaces the category filter with a custom instance defined by a lambda hook.
extendCategoryFilterWith(Function<CategoryFilterInput, CategoryFilterInput>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Extends or replaces the category filter with a custom instance defined by a lambda hook.
extendCategoryQueryWith(Consumer<CategoryTreeQuery>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
Extend the category query part of the category GraphQL query with a partial query provided by a lambda hook that sets additional fields.
extendCategoryQueryWith(Consumer<CategoryTreeQuery>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Extend the category query part of the category GraphQL query with a partial query provided by a lambda hook that sets additional fields.
extendProductFilterWith(Function<ProductAttributeFilterInput, ProductAttributeFilterInput>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Extends or replaces the product attribute filter with a custom instance defined by a lambda hook.
extendProductFilterWith(Function<ProductAttributeFilterInput, ProductAttributeFilterInput>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Extends or replaces the product attribute filter with a custom instance defined by a lambda hook.
extendProductFilterWith(Function<ProductAttributeFilterInput, ProductAttributeFilterInput>) - Method in interface com.adobe.cq.commerce.core.components.models.searchresults.SearchResults
Extends or replaces the product attribute filter with a custom instance defined by a lambda hook.
extendProductQueryWith(Consumer<ProductInterfaceQuery>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Extend the product query part of the category GraphQL query with a partial query provided by a lambda hook that sets additional fields.
extendProductQueryWith(Consumer<ProductInterfaceQuery>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Extend the product GraphQL query with a partial query provided by a lambda hook that sets additional fields.
extendProductQueryWith(Consumer<ProductInterfaceQuery>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Extend the product GraphQL query with a partial query provided by a lambda hook that sets additional fields.
extendProductQueryWith(Consumer<ProductInterfaceQuery>) - Method in interface com.adobe.cq.commerce.core.components.models.searchresults.SearchResults
Extend the product query part of the search GraphQL query with a partial query provided by a lambda hook that sets additional fields.
extendVariantQueryWith(Consumer<SimpleProductQuery>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Extend the product variant GraphQL query with a partial query provided by a lambda hook that sets additional fields.
extendVariantQueryWith(Consumer<SimpleProductQuery>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Extend the product variant GraphQL query with a partial query provided by a lambda hook that sets additional fields.

F

FeaturedCategoryList - Interface in com.adobe.cq.commerce.core.components.models.categorylist
Provides the list of categories to CategoryList Componenet.
FeaturedCategoryListItem - Interface in com.adobe.cq.commerce.core.components.models.categorylist
An item from a category list
fetchCategories() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
Executes the GraphQL query and returns categories.
fetchCategory() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Executes the GraphQL query and returns a category.
fetchProduct() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Executes the GraphQL query and returns a product.
fetchProducts() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Executes the GraphQL query and returns a product.
FilterAttributeMetadata - Interface in com.adobe.cq.commerce.core.search.models
Contains information about search filters useful in places where filter metadata is required.
format(Map<String, String>) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlFormat
Deprecated.
Formats an URL with the given parameters.
format(ParameterType) - Method in interface com.adobe.cq.commerce.core.components.services.urls.GenericUrlFormat
Formats an URL with the given parameters.
fromString(String, Sorter.Order) - Static method in enum com.adobe.cq.commerce.core.search.models.Sorter.Order
Returns the Sort.Order matching the parameter string or returns the default value if the string is invalid.

G

generateCategoryQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
Generates the partial CategoryTree query part of the GraphQL category query.
generateCategoryQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Generates the partial CategoryTree query part of the GraphQL category query.
generateCategoryQueryArgs() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Generates a pair of args for the category query for the instance identifier;
generateCategoryQueryArgs(String) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Generates a pair of args for the category query for a given category identifier;
generatePriceQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
 
generatePriceQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
 
generateProductQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Generates the partial ProductInterface query part of the GraphQL product query.
generateProductQuery() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Generates the partial ProductInterface query part of the GraphQL product query.
generateQuery(String) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Generates a complete category GraphQL query with a selection of the given category identifier.
generateQuery(String) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Generate a complete product GraphQL query with a filter for the given product identifier.
generateQuery(List<String>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
Generates a complete category GraphQL query with a selection of the given category UIDs.
generateQuery(List<String>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Generate a complete product GraphQL query with a filter for the given product identifiers.
GenericUrlFormat<ParameterType> - Interface in com.adobe.cq.commerce.core.components.services.urls
Consumers may implement this interface to provide a custom GenericUrlFormat to the UrlProvider implementation.
get(String, Class<T>) - Method in class com.adobe.cq.commerce.core.components.services.ComponentsConfiguration
 
get(String, T) - Method in class com.adobe.cq.commerce.core.components.services.ComponentsConfiguration
 
getActiveNavigation() - Method in interface com.adobe.cq.commerce.core.components.models.navigation.NavigationModel
 
getAddFilterMap() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregationOption
Get the key value map for this aggregation option.
getAddToWishListEnabled() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
Returns true when the Add to Wish List button is enabled.
getAddToWishListEnabled() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns true when the Add to Wish List button is enabled.
getAllFilters() - Method in interface com.adobe.cq.commerce.core.search.models.SearchOptions
Retrieves all filters, including the category id which is being treated as a special case as a developer convenience.
getAlternateLanguageLinks() - Method in interface com.adobe.cq.commerce.core.components.models.page.PageMetadata
This method is used to provide canonical links to the current page in different languages.
getAppliedAggregations() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
Get the list of aggregations or filters that were applied in this search.
getAppliedFilterDisplayLabel() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregation
Get the filter display label.
getAppliedFilterValue() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregation
Get the currently applied filter value.
getAppliedQueryParameters() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
Get a map of the applied search query string parameters.
getAssetPath() - Method in interface com.adobe.cq.commerce.core.components.models.categorylist.FeaturedCategoryListItem
The path to the asset which overrides the default asset.
getAssetPath() - Method in interface com.adobe.cq.commerce.core.components.models.teaser.CommerceTeaser
Retrieves the URL of the image associated with this teaser.
getAssets() - Method in interface com.adobe.cq.commerce.core.components.datalayer.ProductData
 
getAssets() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getAssets() - Method in interface com.adobe.cq.commerce.core.components.models.product.Variant
 
getAssetsJson() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getAttribute() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchFacet
 
getAttribute() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchFilter
 
getAttribute() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchSort
 
getAttributeCode() - Method in interface com.adobe.cq.commerce.core.search.models.FilterAttributeMetadata
Get the attribute code for this filterable attribute.
getAttributeFilters() - Method in interface com.adobe.cq.commerce.core.search.models.SearchOptions
 
getAttributeInputType() - Method in interface com.adobe.cq.commerce.core.search.models.FilterAttributeMetadata
The input type for the attribute input in the commerce system admin / adminhtml.
getAttributeType() - Method in interface com.adobe.cq.commerce.core.search.models.FilterAttributeMetadata
The type of the attribute in the commerce system.
getAvailableAggregations() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
Get the available search aggregations for the given result set
getBaseSku() - Method in class com.adobe.cq.commerce.core.components.models.common.CombinedSku
Returns the base product's sku.
getBuckets() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchFacet
 
getCallToAction() - Method in interface com.adobe.cq.commerce.core.components.models.common.ProductListItem
Returns the call to action command for the 'Add to Cart' button of the product list item.
getCallToAction() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns the "call to action" configured for this teaser.
getCallToActionText() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns the "call to action text" configured for this teaser.
getCanonicalUrl() - Method in interface com.adobe.cq.commerce.core.components.models.page.PageMetadata
 
getCatalogPage() - Method in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure.Entry
Returns the catalog page of the SiteStructure.Entry.
getCategories() - Method in interface com.adobe.cq.commerce.core.components.datalayer.CategoryListData
 
getCategories() - Method in interface com.adobe.cq.commerce.core.components.models.categorylist.FeaturedCategoryList
Returns the categories data in a list from Magento depending on configurations.
getCategories() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultsStorefrontContext
 
getCategoriesRetriever() - Method in interface com.adobe.cq.commerce.core.components.models.categorylist.FeaturedCategoryList
Returns in instance of the category retriever for fetching category data via GraphQL.
getCategoryFilterHook(SlingHttpServletRequest) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Returns a hook that replaces a given CategoryFilterInput with a new instance constructed from the identifiers available by the given request.
getCategoryIdentifier() - Method in interface com.adobe.cq.commerce.core.components.models.categorylist.FeaturedCategoryListItem
The identifier of this category.
getCategoryIdentifier(SlingHttpServletRequest) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Returns the category identifier used in the given Sling HTTP request.
getCategoryInterfaceComparator() - Method in interface com.adobe.cq.commerce.core.components.models.breadcrumb.Breadcrumb
Deprecated.
this Comparator is not used by the implementation anymore. Instead, the retrieved categories are filtered by the context url path. After that filtering, the categories are sorted by url path in reversed natural order.
getCategoryItems() - Method in interface com.adobe.cq.commerce.core.components.models.categorylist.FeaturedCategoryList
Returns a list of category identifiers configured for this component
getCategoryPage(Page) - Static method in class com.adobe.cq.commerce.core.components.utils.SiteNavigation
Deprecated.
Retrieves the generic category page based on a page or page ancestors using the page path configured via cq:cifCategoryPage property.
getCategoryPages() - Method in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
Returns all category pages within a site.
getCategoryQueryHook() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
 
getCategoryRetriever() - Method in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
Returns in instance of the category retriever for fetching category data via GraphQL.
getCategoryUrlParams() - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
The returned object may contain parameters of the category the product represented by the ProductUrlFormat.Params belongs to.
getClassList() - Method in interface com.adobe.cq.commerce.core.components.models.HeroImage
 
getColor() - Method in interface com.adobe.cq.commerce.core.components.models.product.Variant
 
getCombinedSku() - Method in interface com.adobe.cq.commerce.core.components.models.common.ProductListItem
Returns the SKU of this ProductListItem as CombinedSku
getCombinedSku() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns the SKU of the product displayed by this ProductTeaser as CombinedSku
getCommerceIdentifier() - Method in interface com.adobe.cq.commerce.core.components.models.common.ProductListItem
Returns the identifier of this product.
getCommerceIdentifier() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns the identifier of this product.
getConfiguration() - Method in interface com.adobe.cq.commerce.core.components.client.MagentoGraphqlClient
Returns the complete configuration of the GraphQL client.
getCount() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.RangeBucket
 
getCount() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.ScalarBucket
 
getCount() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregationOption
Get the number of results for this particular aggregation option.
getCssClassModifier() - Method in interface com.adobe.cq.commerce.core.components.models.product.VariantValue
 
getCssClassName() - Method in interface com.adobe.cq.commerce.core.components.models.experiencefragment.CommerceExperienceFragmentContainer
 
getCurrency() - Method in interface com.adobe.cq.commerce.core.components.datalayer.ProductData
 
getCurrency() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
getCurrencyCode() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.Pricing
 
getCurrentKey() - Method in interface com.adobe.cq.commerce.core.search.models.Sorter
 
getCurrentOrderParameters() - Method in interface com.adobe.cq.commerce.core.search.models.SorterKey
 
getCurrentPage() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchStorefrontContext
 
getCurrentPage() - Method in interface com.adobe.cq.commerce.core.search.models.Pager
Get the current page.
getCurrentPage() - Method in interface com.adobe.cq.commerce.core.search.models.SearchOptions
 
getDefaultQuantity() - Method in interface com.adobe.cq.commerce.core.components.models.product.GroupItem
 
getDefaultSorter() - Method in interface com.adobe.cq.commerce.core.search.models.SearchOptions
Returns the default sort parameters in a SorterKey or returns null if default sorting was not set with SearchOptions.setDefaultSorter(String, Sorter.Order).
getDescription() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getDescription() - Method in interface com.adobe.cq.commerce.core.components.models.product.Variant
 
getDirection() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchSort
 
getDiscountAmount() - Method in interface com.adobe.cq.commerce.core.components.datalayer.ProductData
 
getDiscountAmount() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
getDiscountAmountMax() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
getDiscountPercent() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
getDiscountPercentMax() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
getDisplayLabel() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregation
Get the aggregation display label.
getDisplayLabel() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregationOption
Get the display label for a aggregation option.
getEntityIdentifier() - Method in interface com.adobe.cq.commerce.core.components.models.teaser.CommerceTeaserActionItem
Returns the id of the entity associated with this teaser action.
getEntityType() - Method in interface com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier
The type of entity which identifier is for
getEntry(Page) - Method in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
Returns the site navigation entry of the given page.
getEq() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchFilter
 
getExperienceFragmentResource() - Method in interface com.adobe.cq.commerce.core.components.models.experiencefragment.CommerceExperienceFragment
This method returns the first experience fragment that matches the location and product or category identifier of the current page.
getExperienceFragments() - Method in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
Return the experience fragment resources that match the configured locations for the current category
getFacets() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultsStorefrontContext
 
getFilter() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchStorefrontContext
 
getFilterable() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregation
Whether or not this aggregation can actually be used to filter results.
getFilterInputType() - Method in interface com.adobe.cq.commerce.core.search.models.FilterAttributeMetadata
Get the type of the filter.
getFilterValue() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregationOption
Get the filter value for a aggregation option.
getFinalPrice() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
getFinalPriceMax() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
getFormattedDiscountAmount() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
Returns formatted discount amount.
getFormattedDiscountAmountMax() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
Returns formatted maximum discount amount.
getFormattedFinalPrice() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
Returns formatted final price.
getFormattedFinalPriceMax() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
Returns formatted maximum final price.
getFormattedRegularPrice() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
Returns formatted regular price.
getFormattedRegularPriceMax() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
Returns formatted maximum regular price.
getFound() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getFrom() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.Range
 
getFrom() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.RangeBucket
 
getGenericPage(String, Page) - Static method in class com.adobe.cq.commerce.core.components.utils.SiteNavigation
Deprecated.
Retrieves a generic page based on a page or page ancestors using the page path configured via the property of the root page.
getGraphqlEndpoint() - Method in interface com.adobe.cq.commerce.core.components.models.storeconfigexporter.StoreConfigExporter
 
getGroupedProductItems() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getHttpHeaderMap() - Method in interface com.adobe.cq.commerce.core.components.client.MagentoGraphqlClient
Returns the Map of custom HTTP headers used by the GraphQL client.
getHttpHeaders() - Method in interface com.adobe.cq.commerce.core.components.client.MagentoGraphqlClient
Deprecated.
this method will be replaced by MagentoGraphqlClient.getHttpHeaderMap() in the next major release‡
getHttpHeaders() - Method in interface com.adobe.cq.commerce.core.components.models.storeconfigexporter.StoreConfigExporter
 
getId() - Method in interface com.adobe.cq.commerce.core.components.datalayer.CategoryData
 
getId() - Method in interface com.adobe.cq.commerce.core.components.models.navigation.Navigation
 
getId() - Method in interface com.adobe.cq.commerce.core.components.models.product.Variant
 
getId() - Method in interface com.adobe.cq.commerce.core.components.models.product.VariantAttribute
 
getId() - Method in interface com.adobe.cq.commerce.core.components.models.product.VariantValue
 
getId() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.ProductStorefrontContext
 
getIdentifier() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregation
The identifier (e.g.
getImage() - Method in interface com.adobe.cq.commerce.core.components.datalayer.CategoryData
 
getImage() - Method in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
 
getImage() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns url of swatch image of the product for display for this ProductTeaser
getImageAlt() - Method in interface com.adobe.cq.commerce.core.components.models.common.ProductListItem
Returns the product image alt text of this ProductListItem.
getImageAlt() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns alt text of swatch image of the product for display for this ProductTeaser
getImageSrc() - Method in interface com.adobe.cq.commerce.core.components.models.HeroImage
 
getImageUrl() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultProduct
 
getImageURL() - Method in interface com.adobe.cq.commerce.core.components.models.common.ProductListItem
Returns the product image URL of this ProductListItem.
getIn() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchFilter
 
getInStock() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getInStock() - Method in interface com.adobe.cq.commerce.core.components.models.product.Variant
 
getItems() - Method in interface com.adobe.cq.commerce.core.components.models.navigation.Navigation
 
getItems() - Method in interface com.adobe.cq.commerce.core.components.models.navigation.NavigationItem
 
getJson() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.CommerceStorefrontContext
 
getKeys() - Method in interface com.adobe.cq.commerce.core.search.models.Sorter
 
getLabel() - Method in interface com.adobe.cq.commerce.core.components.models.product.Asset
 
getLabel() - Method in interface com.adobe.cq.commerce.core.components.models.product.VariantAttribute
 
getLabel() - Method in interface com.adobe.cq.commerce.core.components.models.product.VariantValue
 
getLabel() - Method in interface com.adobe.cq.commerce.core.search.models.SorterKey
 
getLandingPage() - Method in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
Returns the landing page of the site structure, which is the first ancestor of page the site structure with the SiteStructure.PN_NAV_ROOT set to true.
getLanguage() - Method in interface com.adobe.cq.commerce.core.components.models.storeconfigexporter.StoreConfigExporter
 
getLinkTarget() - Method in interface com.adobe.cq.commerce.core.components.models.categorylist.FeaturedCategoryList
Returns the link target for the links generated on the component.
getLinkTarget() - Method in interface com.adobe.cq.commerce.core.components.models.productcarousel.ProductCarousel
Returns the link target for the links generated on the product carousel.
getLinkTarget() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns the link target for the links generated on the product teaser.
getMax() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.StatsBucket
 
getMetaDescription() - Method in interface com.adobe.cq.commerce.core.components.models.page.PageMetadata
 
getMetaKeywords() - Method in interface com.adobe.cq.commerce.core.components.models.page.PageMetadata
 
getMetaTitle() - Method in interface com.adobe.cq.commerce.core.components.models.page.PageMetadata
Although this method refers to "metaTitle", this is used to set the title tag of the HTML page.
getMethod() - Method in interface com.adobe.cq.commerce.core.components.models.storeconfigexporter.StoreConfigExporter
 
getMin() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.StatsBucket
 
getMiniaccountResource() - Method in interface com.adobe.cq.commerce.core.components.models.header.Header
 
getMinicartResource() - Method in interface com.adobe.cq.commerce.core.components.models.header.Header
 
getModelTitle() - Method in interface com.adobe.cq.commerce.core.components.models.contentfragment.CommerceContentFragment
 
getMorePagesAfter() - Method in interface com.adobe.cq.commerce.core.search.models.Pager
Whether there are additional pages in pagination set than are displayable currently at the end of the page list.
getMorePagesBefore() - Method in interface com.adobe.cq.commerce.core.search.models.Pager
Whether there are additional pages in pagination set than are displayable currently at the start of the page list.
getName() - Method in interface com.adobe.cq.commerce.core.components.datalayer.CategoryData
 
getName() - Method in interface com.adobe.cq.commerce.core.components.models.experiencefragment.CommerceExperienceFragment
Returns the technical name of the experience fragment.
getName() - Method in interface com.adobe.cq.commerce.core.components.models.product.GroupItem
 
getName() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getName() - Method in interface com.adobe.cq.commerce.core.components.models.product.Variant
 
getName() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns name of the configured Product for this ProductTeaser
getName() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.CategoryStorefrontContext
 
getName() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.ProductStorefrontContext
 
getName() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultCategory
 
getName() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultProduct
 
getName() - Method in interface com.adobe.cq.commerce.core.search.models.SorterKey
 
getNavigationList() - Method in interface com.adobe.cq.commerce.core.components.models.navigation.NavigationModel
 
getNavigationRootPage(Page) - Static method in class com.adobe.cq.commerce.core.components.utils.SiteNavigation
Deprecated.
Retrieves the navigation root related to the specified page.
getNavigationRootPageTitle() - Method in interface com.adobe.cq.commerce.core.components.models.header.Header
 
getNavigationRootPageUrl() - Method in interface com.adobe.cq.commerce.core.components.models.header.Header
 
getNextPageParameters() - Method in interface com.adobe.cq.commerce.core.search.models.Pager
Get the mext page parameters for supporting linking to the mext page.
getOppositeOrderParameters() - Method in interface com.adobe.cq.commerce.core.search.models.SorterKey
 
getOptionCount() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregation
Get the number of aggregation options exist for the current aggregation.
getOptions() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregation
Get the search aggregation options available for this aggregation.
getOrder() - Method in interface com.adobe.cq.commerce.core.search.models.SorterKey
 
getPage() - Method in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure.Entry
The Page itself, represented by the SiteStructure.Entry.
getPage() - Method in class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
getPage() - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
getPage() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultsStorefrontContext
 
getPageNumber() - Method in interface com.adobe.cq.commerce.core.search.models.PagerPage
The number of this page.
getPager() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
 
getPages() - Method in interface com.adobe.cq.commerce.core.search.models.Pager
Get all pagination parameters available for the current result set.
getPageSize() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchStorefrontContext
 
getPageSize() - Method in interface com.adobe.cq.commerce.core.search.models.SearchOptions
 
getPageUrl() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregationOption
Get the page URL for this aggregation option.
getPaginationType() - Method in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Returns the type of pagination that should be displayed.
getParameterNames() - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlFormat
Deprecated.
Returns a set of all parameter names the url format implementation supports when parsing a pathinfo.
getParameters() - Method in interface com.adobe.cq.commerce.core.search.models.PagerPage
Get the parameters for this page.
getParentId() - Method in interface com.adobe.cq.commerce.core.components.models.navigation.Navigation
 
getPath() - Method in interface com.adobe.cq.commerce.core.components.models.product.Asset
 
getPerPage() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultsStorefrontContext
 
getPhrase() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchStorefrontContext
 
getPosition() - Method in interface com.adobe.cq.commerce.core.components.models.product.Asset
 
getPreviousPageParameters() - Method in interface com.adobe.cq.commerce.core.search.models.Pager
Get the previous page parameters for supporting linking to the previous page.
getPrice() - Method in interface com.adobe.cq.commerce.core.components.datalayer.ProductData
 
getPrice() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultProduct
 
getPriceRange() - Method in interface com.adobe.cq.commerce.core.components.models.common.ProductListItem
Returns the price range of this ProductListItem.
getPriceRange() - Method in interface com.adobe.cq.commerce.core.components.models.product.GroupItem
 
getPriceRange() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getPriceRange() - Method in interface com.adobe.cq.commerce.core.components.models.product.Variant
 
getPriceRange() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns the price range.
getPricing() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.ProductStorefrontContext
 
getProduct() - Method in interface com.adobe.cq.commerce.core.components.models.common.ProductListItem
Returns the backend product using the GraphQL ProductInterface.
getProductFilterHook(SlingHttpServletRequest) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Returns a hook that replaces a given ProductAttributeFilterInput with a new instance constructed from the identifiers available by the given request.
getProductIdentifier(SlingHttpServletRequest) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Returns the product identifier (sku) used in the given Sling HTTP request.
getProductIdentifiers() - Method in interface com.adobe.cq.commerce.core.components.models.productcarousel.ProductCarousel
Deprecated.
getProductListItems() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
Get the result product list items.
getProductPage(Page) - Static method in class com.adobe.cq.commerce.core.components.utils.SiteNavigation
Deprecated.
Retrieves the generic product page based on the current page or current page ancestors using the page path configured via cq:cifProductPage property.
getProductPages() - Method in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
Returns all product pages within a site.
getProductQueryHook() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
 
getProductRetriever() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getProductRetriever() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns in instance of the product retriever for fetching product data via GraphQL.
getProducts() - Method in interface com.adobe.cq.commerce.core.components.models.productcarousel.ProductCarousel
Returns the list of products to be displayed in the carousel.
getProducts() - Method in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Returns the product list's items collection, as ProductListItems elements.
getProducts() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultsStorefrontContext
 
getProductsRetriever() - Method in interface com.adobe.cq.commerce.core.components.models.productcarousel.ProductCarousel
Returns in instance of the products retriever for fetching product data via GraphQL.
getQueryTypes() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchStorefrontContext
 
getRange() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchFilter
 
getRank() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultCategory
 
getRank() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultProduct
 
getRank() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultSuggestion
 
getRegularPrice() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
getRegularPrice() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.Pricing
 
getRegularPriceMax() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
getRemoveFilterMap() - Method in interface com.adobe.cq.commerce.core.search.models.SearchAggregation
Get the map of attributes that will remove this aggregation from results.
getRenderResource() - Method in interface com.adobe.cq.commerce.core.components.models.experiencefragment.CommerceExperienceFragmentContainer
Returns the ExperienceFragment resource to be rendered.
getSearchAggregations() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
Get the available search aggregations for the given result set.
getSearchbarResource() - Method in interface com.adobe.cq.commerce.core.components.models.header.Header
 
getSearchOptions() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
Get the search options used to provide this search result set.
getSearchQuery() - Method in interface com.adobe.cq.commerce.core.search.models.SearchOptions
 
getSearchRequestId() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultsStorefrontContext
 
getSearchRequestId() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchStorefrontContext
 
getSearchResultsPage() - Method in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
 
getSearchResultsPage(Page) - Static method in class com.adobe.cq.commerce.core.components.utils.SiteNavigation
Deprecated.
Retrieves the generic search page based on a page or page ancestors using the page path configured via cq:cifSearchResultsPage property.
getSearchResultsPageUrl() - Method in interface com.adobe.cq.commerce.core.components.models.searchbar.Searchbar
 
getSearchResultsSet() - Method in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Get the search result set.
getSearchResultsStorefrontContext() - Method in interface com.adobe.cq.commerce.core.components.models.searchresults.SearchResults
Returns the storefront context related to search results
getSearchStorefrontContext() - Method in interface com.adobe.cq.commerce.core.components.models.searchresults.SearchResults
Returns the storefront context related to search input
getSearchUnitId() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultsStorefrontContext
 
getSearchUnitId() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchStorefrontContext
 
getSku() - Method in interface com.adobe.cq.commerce.core.components.models.product.GroupItem
 
getSku() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getSku() - Method in interface com.adobe.cq.commerce.core.components.models.product.Variant
 
getSku() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns the effective SKU of the product displayed by this ProductTeaser.
getSku() - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
getSku() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.ProductStorefrontContext
 
getSku() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultProduct
 
getSKU() - Method in interface com.adobe.cq.commerce.core.components.datalayer.ProductData
 
getSKU() - Method in interface com.adobe.cq.commerce.core.components.models.common.ProductListItem
Returns the product SKU of this ProductListItem.
getSlug() - Method in interface com.adobe.cq.commerce.core.components.models.common.ProductListItem
Returns the product slug of this ProductListItem.
getSort() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchStorefrontContext
 
getSorter() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
 
getSorterKeys() - Method in interface com.adobe.cq.commerce.core.search.models.SearchOptions
 
getSpecialPrice() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.Pricing
 
getStorefrontContext() - Method in interface com.adobe.cq.commerce.core.components.models.product.GroupItem
 
getStorefrontContext() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
Return the product storefront context
getStorefrontContext() - Method in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
Return the categories storefront context for a list of products
getStoreRootUrl() - Method in interface com.adobe.cq.commerce.core.components.models.storeconfigexporter.StoreConfigExporter
 
getStoreView() - Method in interface com.adobe.cq.commerce.core.components.models.storeconfigexporter.StoreConfigExporter
 
getSuggestion() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultSuggestion
 
getSuggestions() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultsStorefrontContext
 
getSwatchType() - Method in interface com.adobe.cq.commerce.core.components.models.product.VariantValue
 
getTitle() - Method in interface com.adobe.cq.commerce.core.components.models.navigation.NavigationItem
 
getTitle() - Method in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
Returns the title of this ProductList.
getTitle() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchBucket
 
getTitle() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchFacet
 
getTitleType() - Method in interface com.adobe.cq.commerce.core.components.models.categorylist.FeaturedCategoryList
Should return the HTML tag type for the component title.
getTitleType() - Method in interface com.adobe.cq.commerce.core.components.models.productcarousel.ProductCarousel
Should return the HTML tag type for the component title.
getTo() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.Range
 
getTo() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.RangeBucket
 
getTotalPages() - Method in interface com.adobe.cq.commerce.core.search.models.Pager
Get the total number of pages.
getTotalResults() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
Get the total number of results.
getType() - Method in interface com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier
The type of the identifier
getType() - Method in interface com.adobe.cq.commerce.core.components.models.product.Asset
 
getType() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchFacet
 
getUid() - Method in interface com.adobe.cq.commerce.core.components.models.product.VariantValue
 
getUid() - Method in class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
getUrl() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns the url of the product page for this ProductTeaser
getUrl() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultCategory
 
getUrl() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.SearchResultProduct
 
getURL() - Method in interface com.adobe.cq.commerce.core.components.models.navigation.NavigationItem
 
getUrlKey() - Method in class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
getUrlKey() - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
getUrlKey() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.CategoryStorefrontContext
 
getUrlPath() - Method in class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
getUrlPath() - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
Deprecated.
getUrlPath() - Method in interface com.adobe.cq.commerce.core.components.storefrontcontext.CategoryStorefrontContext
 
getUrlRewrites() - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
getValue() - Method in interface com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier
The value of the identifier
getValueMap() - Method in class com.adobe.cq.commerce.core.components.services.ComponentsConfiguration
Returns a ValueMap with the configuration properties.
getValues() - Method in interface com.adobe.cq.commerce.core.components.models.product.VariantAttribute
 
getVariantAttributes() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getVariantAttributes() - Method in interface com.adobe.cq.commerce.core.components.models.product.Variant
 
getVariantAttributesUid() - Method in interface com.adobe.cq.commerce.core.components.models.product.Variant
 
getVariants() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getVariantsJson() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
getVariantSku() - Method in class com.adobe.cq.commerce.core.components.models.common.CombinedSku
For variants of a configurable product, this returns the variant's sku.
getVariantSku() - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
getVariantUrlKey() - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
Deprecated.
getVisibleSections() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
Returns a set of sections to be displayed.
getWishListEnabled() - Method in interface com.adobe.cq.commerce.core.components.models.account.MiniAccount
Returns true when the wish list is enabled and should be shown in the account drop down.
GroupItem - Interface in com.adobe.cq.commerce.core.components.models.product
GroupItem is a view model interface representing the item of a grouped product.

H

hasAggregations() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
 
hasPagination() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
 
hasSorting() - Method in interface com.adobe.cq.commerce.core.search.models.SearchResultsSet
 
Header - Interface in com.adobe.cq.commerce.core.components.models.header
Sling Model API for the Header component
HeroImage - Interface in com.adobe.cq.commerce.core.components.models
API for the Hero Image component

I

identifier - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Identifier of the category that should be fetched.
identifier - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
SKU identifier of the product that should be fetched.
identifiers - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
Identifiers of the categories that should be fetched.
identifiers - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Product SKU identifiers of the product that should be fetched.
IMAGE - com.adobe.cq.commerce.core.components.models.product.VariantValue.SwatchType
 
IMAGE_SECTION - Static variable in interface com.adobe.cq.commerce.core.components.models.product.Product
 
INTELLIGENT - com.adobe.cq.commerce.core.components.storefrontcontext.SearchFacetType
 
isActive() - Method in interface com.adobe.cq.commerce.core.components.models.navigation.NavigationItem
 
isAddToCartEnabled() - Method in interface com.adobe.cq.commerce.core.components.models.productcarousel.ProductCarousel
Indicates whether the 'Add to Cart' button should be displayed on the product carousel item.
isAddToCartEnabled() - Method in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Indicates whether the 'Add to Cart' button should be displayed on the product collection item.
isAddToWishListEnabled() - Method in interface com.adobe.cq.commerce.core.components.models.productcarousel.ProductCarousel
Indicates whether the 'Add to Wish List' button should be displayed on the product carousel item.
isAddToWishListEnabled() - Method in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Indicates whether the 'Add to Wish List' button should be displayed on the product collection item.
isBundleProduct() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
isCatalogPage(Page) - Method in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
Returns true when the given Page is a catalog page.
isCategoryPage(Page) - Method in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
Returns true when the given Page is a category page.
isCategoryPage(Page) - Static method in class com.adobe.cq.commerce.core.components.utils.SiteNavigation
Deprecated.
Returns true if the currentPage is the category page referenced by the cq:cifCategoryPage property in the page hierarchy.
isClientSidePriceLoadingEnabled() - Method in interface com.adobe.cq.commerce.core.components.models.storeconfigexporter.StoreConfigExporter
 
isConfigurable() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
isConfigured() - Method in interface com.adobe.cq.commerce.core.components.models.categorylist.FeaturedCategoryList
Returns true if the component is correctly configured, false otherwise.
isConfigured() - Method in interface com.adobe.cq.commerce.core.components.models.productcarousel.ProductCarousel
Returns true if the component is correctly configured, false otherwise.
isDiscounted() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
isDisplayed() - Method in interface com.adobe.cq.commerce.core.search.models.PagerPage
Whether this particular page should be displayed in the pager.
isEmpty() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
Indicates if a product price is not available.
isGiftCardProduct() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
isGroupedProduct() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
isProductPage(Page) - Method in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
Returns true when the given Page is a product page.
isProductPage(Page) - Static method in class com.adobe.cq.commerce.core.components.utils.SiteNavigation
Deprecated.
Returns true if the currentPage is the product page referenced by the cq:cifProductPage property in the page hierarchy.
isRange() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
isSelected() - Method in interface com.adobe.cq.commerce.core.search.models.SorterKey
 
isStaged() - Method in interface com.adobe.cq.commerce.core.components.models.common.ProductListItem
 
isStaged() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
The version 1 of the product component always returns false as it does not support this feature.
isStaged() - Method in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
The version 1 of the productlist component always returns false as it does not support this feature.
isStartPrice() - Method in interface com.adobe.cq.commerce.core.components.models.common.Price
 
isVirtualProduct() - Method in interface com.adobe.cq.commerce.core.components.models.product.GroupItem
 
isVirtualProduct() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
 
isVirtualProduct() - Method in interface com.adobe.cq.commerce.core.components.models.productteaser.ProductTeaser
Returns true if the product is a virtual product.

L

loadClientPrice() - Method in interface com.adobe.cq.commerce.core.components.models.product.Product
Deprecated.
Per component client-side price loading is deprecated. This information is exposed in the StoreConfigExporter and enabled site wide.
loadClientPrice() - Method in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Deprecated.
Per component client-side price loading is deprecated. This information is exposed in the StoreConfigExporter and enabled site wide.

M

MagentoGraphqlClient - Interface in com.adobe.cq.commerce.core.components.client
This interface gives access to a GraphqlClient configured for a given context.
map() - Method in class com.adobe.cq.commerce.core.components.services.urls.UrlProvider.ParamsBuilder
Deprecated.
MiniAccount - Interface in com.adobe.cq.commerce.core.components.models.account
 

N

Navigation - Interface in com.adobe.cq.commerce.core.components.models.navigation
Sling model interface to represent a navigation.
NavigationItem - Interface in com.adobe.cq.commerce.core.components.models.navigation
Simple data model for a navigation item of the navigation component.
NavigationModel - Interface in com.adobe.cq.commerce.core.components.models.navigation
Sling model interface for the navigation component.
NN_FRAGMENTS - Static variable in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
Name of the child node where the fragment elements are stored

O

OPENING_BRACKETS - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlFormat
Deprecated.
A CharSequence to be used to write defaults to the format when a mandatory parameter is missing.
opposite() - Method in enum com.adobe.cq.commerce.core.search.models.Sorter.Order
 
OPTIONS_SECTION - Static variable in interface com.adobe.cq.commerce.core.components.models.product.Product
 

P

page(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.UrlProvider.ParamsBuilder
Deprecated.
PAGE_PARAM - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Deprecated.
PageMetadata - Interface in com.adobe.cq.commerce.core.components.models.page
 
Pager - Interface in com.adobe.cq.commerce.core.search.models
This class is responsible for providing pagination support for search results.
PagerPage - Interface in com.adobe.cq.commerce.core.search.models
Contains metadata required to support display of pagination options.
pageSize - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Page size for pagination of products in a category.
PARAMETER_SORT_KEY - Static variable in interface com.adobe.cq.commerce.core.search.models.Sorter
The sort key request parameter name.
PARAMETER_SORT_ORDER - Static variable in interface com.adobe.cq.commerce.core.search.models.Sorter
The sort order request parameter name.
Params() - Constructor for class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
Params() - Constructor for class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
Params(CategoryUrlFormat.Params) - Constructor for class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
Params(ProductUrlFormat.Params) - Constructor for class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
Params(CategoryInterface) - Constructor for class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
Params(ProductInterface) - Constructor for class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
Params(Map<String, String>) - Constructor for class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
Deprecated.
Params(Map<String, String>) - Constructor for class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
Deprecated.
ParamsBuilder() - Constructor for class com.adobe.cq.commerce.core.components.services.urls.UrlProvider.ParamsBuilder
Deprecated.
 
parse(String) - Static method in class com.adobe.cq.commerce.core.components.models.common.CombinedSku
Parses a combined sku in its String representation.
parse(RequestPathInfo, RequestParameterMap) - Method in interface com.adobe.cq.commerce.core.components.services.urls.GenericUrlFormat
Parses a given request URI using the internal configured pattern.
parse(RequestPathInfo, RequestParameterMap) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlFormat
Deprecated.
Parses a given request URI using the internal configured pattern.
parseCategoryUrlFormatParameters(SlingHttpServletRequest) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Parses and returns the CategoryUrlFormat.Params used in the given Sling HTTP request based on the URLProvider configuration for category page URLs.
parseProductUrlFormatParameters(SlingHttpServletRequest) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Parses and returns the ProductUrlFormat.Params used in the given SlingHttpServletRequest based on the URLProvider configuration for product page URLs.
performSearch(SearchOptions, Resource, Page, SlingHttpServletRequest) - Method in interface com.adobe.cq.commerce.core.search.services.SearchResultsService
Perform a search against the commerce backend and return a SearchResultsSet for consumption by the frontend.
performSearch(SearchOptions, Resource, Page, SlingHttpServletRequest, Consumer<ProductInterfaceQuery>) - Method in interface com.adobe.cq.commerce.core.search.services.SearchResultsService
Perform a search against the commerce backend and return a SearchResultsSet for consumption by the frontend.
performSearch(SearchOptions, Resource, Page, SlingHttpServletRequest, Consumer<ProductInterfaceQuery>, AbstractCategoryRetriever) - Method in interface com.adobe.cq.commerce.core.search.services.SearchResultsService
Perform a search against the commerce backend and return a SearchResultsSet for consumption by the frontend.
performSearch(SearchOptions, Resource, Page, SlingHttpServletRequest, Consumer<ProductInterfaceQuery>, Function<ProductAttributeFilterInput, ProductAttributeFilterInput>) - Method in interface com.adobe.cq.commerce.core.search.services.SearchResultsService
Perform a search against the commerce backend and return a SearchResultsSet for consumption by the frontend.
PINNED - com.adobe.cq.commerce.core.components.storefrontcontext.SearchFacetType
 
PN_ACTION_CATEGORY_ID - Static variable in interface com.adobe.cq.commerce.core.components.models.teaser.CommerceTeaser
Name of the resource property that stores category identifier which is used to build call-to-action link for category page
PN_ACTION_PRODUCT_SKU - Static variable in interface com.adobe.cq.commerce.core.components.models.teaser.CommerceTeaser
Name of the resource property that stores the product SKU which is used to build call-to-action link for product page Used by V2 of the CommerceTeaser component.
PN_ACTION_PRODUCT_SLUG - Static variable in interface com.adobe.cq.commerce.core.components.models.teaser.CommerceTeaser
Name of the resource property that stores the product url_key which is used to build call-to-action link for product page Used by V1 of the CommerceTeaser component.
PN_CQ_CATEGORIES - Static variable in interface com.adobe.cq.commerce.core.components.models.experiencefragment.CommerceExperienceFragment
Name of the configuration property that specifies the categories selected in an experience fragment.
PN_CQ_PRODUCTS - Static variable in interface com.adobe.cq.commerce.core.components.models.experiencefragment.CommerceExperienceFragment
Name of the configuration property that specifies the products selected in an experience fragment.
PN_DEFAULT_SORT_FIELD - Static variable in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Name of the String resource property for the default product sort field.
PN_DEFAULT_SORT_ORDER - Static variable in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Name of the String resource property for the default product sort order.
PN_ENABLE_ADD_TO_CART - Static variable in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Name of the boolean resource property indicating if the product collection should display the 'Add to Cart' button on the product collection items.
PN_ENABLE_ADD_TO_WISH_LIST - Static variable in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Name of the boolean resource property indicating if the product collection should display the 'Add to Wish List' button on the product collection items.
PN_FRAGMENT_LOCATION - Static variable in interface com.adobe.cq.commerce.core.components.models.experiencefragment.CommerceExperienceFragment
Name of the configuration property that specifies the experience fragment location name.
PN_LINK_ELEMENT - Static variable in interface com.adobe.cq.commerce.core.components.models.contentfragment.CommerceContentFragment
Property name to define the name of the content fragment element which links the content fragment to a product or category.
PN_LOAD_CLIENT_PRICE - Static variable in interface com.adobe.cq.commerce.core.components.models.product.Product
Name of the boolean resource property indicating if the product component should load prices on the client-side.
PN_LOAD_CLIENT_PRICE - Static variable in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Deprecated.
PN_MODEL_PATH - Static variable in interface com.adobe.cq.commerce.core.components.models.contentfragment.CommerceContentFragment
Property name to define the content fragment model of the displayed content fragment.
PN_NAV_ROOT - Static variable in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
 
PN_PAGE_SIZE - Static variable in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Name of the String resource property indicating number of products to render on front-end.
PN_PAGINATION_TYPE - Static variable in interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection
Name of the String resource property indicating the type of pagination that should be displayed.
PN_PARENT_PATH - Static variable in interface com.adobe.cq.commerce.core.components.models.contentfragment.CommerceContentFragment
Property name to define the parent path of the displayed content fragment.
PN_SHOW_IMAGE - Static variable in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
Name of the boolean resource property indicating if the product list should render the category image.
PN_SHOW_MAIN_CATEGORIES - Static variable in interface com.adobe.cq.commerce.core.components.models.navigation.Navigation
Boolean property for adding to navigation the main categories of the catalog instead of the catalog root page.
PN_SHOW_TITLE - Static variable in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
Name of the boolean resource property indicating if the product list should render the category title.
POPULAR - com.adobe.cq.commerce.core.components.storefrontcontext.SearchFacetType
 
populate() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
 
populate() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
 
populate() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
 
populate() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
 
populate() - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractRetriever
Executes the query and parses the response.
Price - Interface in com.adobe.cq.commerce.core.components.models.common
Asset is a view model interface representing a product asset.
PRICE_SECTION - Static variable in interface com.adobe.cq.commerce.core.components.models.product.Product
 
Pricing - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
 
product - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Product instance.
Product - Interface in com.adobe.cq.commerce.core.components.models.product
Product is the sling model interface for the CIF core product component.
PRODUCT - com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier.EntityType
 
PRODUCT_PAGE_URL_FORMAT - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlFormat
Deprecated.
The value of the UrlFormat.PROP_USE_AS property to be set when the UrlFormat should be used to format and parse product urls.
productAttributeFilterHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Lambda that allows to replace or extend the product attribute filters.
productAttributeFilterHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Lambda that allows to replace or extend the product attribute filters.
ProductCarousel - Interface in com.adobe.cq.commerce.core.components.models.productcarousel
 
ProductCollection - Interface in com.adobe.cq.commerce.core.components.models.productcollection
 
ProductData - Interface in com.adobe.cq.commerce.core.components.datalayer
 
ProductList - Interface in com.adobe.cq.commerce.core.components.models.productlist
 
ProductListItem - Interface in com.adobe.cq.commerce.core.components.models.common
 
productQueryHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Lambda that extends the product query.
productQueryHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Lambda that extends the product query.
productQueryHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Lambda that extends the product query.
products - com.adobe.cq.commerce.core.components.storefrontcontext.QueryType
 
products - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
List of product instances.
ProductStorefrontContext - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
 
ProductTeaser - Interface in com.adobe.cq.commerce.core.components.models.productteaser
Product Teaser is the sling model interface for the CIF Teaser component.
ProductUrlFormat - Interface in com.adobe.cq.commerce.core.components.services.urls
This interface represents a specific implementation of the GenericUrlFormat for product urls.
ProductUrlFormat.Params - Class in com.adobe.cq.commerce.core.components.services.urls
Instances of this class hold the parameters used by implementations of the ProductUrlFormat.
PROP_USE_AS - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlFormat
Deprecated.
The service registration property used to identify the purpose of the UrlFormat.

Q

QUANTITY_SECTION - Static variable in interface com.adobe.cq.commerce.core.components.models.product.Product
 
query - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractRetriever
Generated or fully customized query.
QueryType - Enum in com.adobe.cq.commerce.core.components.storefrontcontext
 

R

Range - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
 
RangeBucket - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
Interface for range search buckets in search results context required by the MSE frontend API
retainParsableParameters(ParameterType) - Method in interface com.adobe.cq.commerce.core.components.services.urls.GenericUrlFormat
Implementations may return a subset of parameters from the given parameters when they parse less or other parameters then available for formatting.
retrieveCurrentlyAvailableCommerceFilters(Page) - Method in interface com.adobe.cq.commerce.core.search.services.SearchFilterService
Service to retrieve available search filters from the backing commerce system.
RT_CATALOG_PAGE - Static variable in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
Sling resource type for catalog landing page.
RT_CATALOG_PAGE - Static variable in interface com.adobe.cq.commerce.core.components.models.navigation.Navigation
Sling resource type for catalog landing page.
RT_CATALOG_PAGE_V3 - Static variable in interface com.adobe.cq.commerce.core.components.models.common.SiteStructure
 
RT_CATALOG_PAGE_V3 - Static variable in interface com.adobe.cq.commerce.core.components.models.navigation.Navigation
 
RUNTIME_ERROR_CATEGORY - Static variable in interface com.adobe.cq.commerce.core.components.client.MagentoGraphqlClient
A category string used for Error instances returned by the MagentoGraphqlClient implementation in case of a RuntimeException being caught.

S

ScalarBucket - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
Interface for scalar search buckets in search results context required by the MSE frontend API
SearchAggregation - Interface in com.adobe.cq.commerce.core.search.models
Represents a search aggregation.
SearchAggregationOption - Interface in com.adobe.cq.commerce.core.search.models
Represents an aggregation option.
Searchbar - Interface in com.adobe.cq.commerce.core.components.models.searchbar
Sling Model API for the Searchbar component
SearchBucket - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
Interface for search buckets in search results context required by the MSE frontend API This is extended by: RangeBucket ScalarBucket StatsBucket
SearchFacet - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
Interface for search facets in search results context required by the MSE frontend API
SearchFacetType - Enum in com.adobe.cq.commerce.core.components.storefrontcontext
 
SearchFilter - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
 
SearchFilterService - Interface in com.adobe.cq.commerce.core.search.services
This service is responsible for retrieving search filter and attribute metadata from the commerce backend.
SearchOptions - Interface in com.adobe.cq.commerce.core.search.models
Represents a set of parameters that can be used to query a product search service.
SearchResultCategory - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
Interface for categories in search results context required by the MSE frontend API
SearchResultProduct - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
Interface for products in search results context required by the MSE frontend API
SearchResults - Interface in com.adobe.cq.commerce.core.components.models.searchresults
Don't forget the comment
SearchResultsService - Interface in com.adobe.cq.commerce.core.search.services
This service hides the interaction between the GraphQL backend and the Sling component models.
SearchResultsSet - Interface in com.adobe.cq.commerce.core.search.models
Represents a set of search results from a backend service.
SearchResultsStorefrontContext - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
Interface for search results context required by the MSE frontend API
SearchResultSuggestion - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
Interface for suggestion in search results context required by the MSE frontend API
SearchSort - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
 
SearchStorefrontContext - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
 
setCurrentPage(int) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Sets the current page for product pagination.
setDefaultSorter(String, Sorter.Order) - Method in interface com.adobe.cq.commerce.core.search.models.SearchOptions
Sets the default sort order of products which is used when no sorting related requests parameters exist in the request.
setIdentifier(String) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Set the identifier and the identifier type of the category that should be fetched.
setIdentifier(String) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Set the identifier of the product that should be fetched.
setIdentifiers(List<String>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoriesRetriever
Set the identifiers of the categories that should be fetched.
setIdentifiers(List<String>) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Set the identifiers of the products that should be fetched.
setPage(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
setPage(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
setPageSize(int) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractCategoryRetriever
Sets the page size for product pagination.
setQuery(String) - Method in class com.adobe.cq.commerce.core.components.models.retriever.AbstractRetriever
Replace the query with your own fully customized query.
setSku(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
setUid(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
setUrlKey(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
setUrlKey(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
setUrlPath(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.CategoryUrlFormat.Params
 
setUrlPath(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
Deprecated.
setUrlRewrites(List<UrlRewrite>) - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
setVariantSku(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
 
setVariantUrlKey(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.ProductUrlFormat.Params
Deprecated.
shouldInclude(Page, CategoryInterface) - Method in interface com.adobe.cq.commerce.core.components.services.sitemap.SitemapCategoryFilter
Implementations may return true when the given CategoryInterface should be included in the category sitemap, false otherwise.
shouldInclude(Page, ProductInterface) - Method in interface com.adobe.cq.commerce.core.components.services.sitemap.SitemapProductFilter
Implementations may return true when the given ProductInterface should be included in the product sitemap, false otherwise.
showImage() - Method in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
 
showTitle() - Method in interface com.adobe.cq.commerce.core.components.models.productlist.ProductList
Returns true if the category / product list title should be rendered.
SitemapCategoryFilter - Interface in com.adobe.cq.commerce.core.components.services.sitemap
A service interface consumers may implement to provide a filter for categories to include in the product sitemap.
SitemapProductFilter - Interface in com.adobe.cq.commerce.core.components.services.sitemap
A service interface consumers may implement to provide a filter for products to include in the product sitemap.
SiteNavigation - Class in com.adobe.cq.commerce.core.components.utils
Deprecated.
use SiteStructure instead
SiteNavigation() - Constructor for class com.adobe.cq.commerce.core.components.utils.SiteNavigation
Deprecated.
 
SiteStructure - Interface in com.adobe.cq.commerce.core.components.models.common
The SiteStructure interface provides access to the CIF specific pages of a site, including category pages, product pages the search results page and the landing page.
SiteStructure.Entry - Interface in com.adobe.cq.commerce.core.components.models.common
This interface describes the entries returned by the SiteStructure when accessing specific pages like product pages, category pages or the search results page.
size() - Method in class com.adobe.cq.commerce.core.components.services.ComponentsConfiguration
 
sku(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.UrlProvider.ParamsBuilder
Deprecated.
SKU - com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier.IdentifierType
 
SKU_PARAM - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Deprecated.
SKU_SECTION - Static variable in interface com.adobe.cq.commerce.core.components.models.product.Product
 
SortDirection - Enum in com.adobe.cq.commerce.core.components.storefrontcontext
 
Sorter - Interface in com.adobe.cq.commerce.core.search.models
Provides sorting support for product search results and represents the data model for the product sorter UI.
Sorter.Order - Enum in com.adobe.cq.commerce.core.search.models
Enum to define the sort order: ascending and descending.
SorterKey - Interface in com.adobe.cq.commerce.core.search.models
Represents a sort key with sort order in the data model of product sorter UI.
StatsBucket - Interface in com.adobe.cq.commerce.core.components.storefrontcontext
Interface for stats search buckets in search results context required by the MSE frontend API
STORE_CODE_PROPERTY - Static variable in interface com.adobe.cq.commerce.core.components.client.MagentoGraphqlClient
 
StoreConfigExporter - Interface in com.adobe.cq.commerce.core.components.models.storeconfigexporter
This model gives access to the cif cloud service configuration of a given Page.
suggestions - com.adobe.cq.commerce.core.components.storefrontcontext.QueryType
 

T

TEXT - com.adobe.cq.commerce.core.components.models.product.VariantValue.SwatchType
 
TITLE_SECTION - Static variable in interface com.adobe.cq.commerce.core.components.models.product.Product
 
toCategoryUrl(SlingHttpServletRequest, Page, CategoryUrlFormat.Params) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Returns the category page URL.
toCategoryUrl(SlingHttpServletRequest, Page, String) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Returns the category page URL.
toCategoryUrl(SlingHttpServletRequest, Page, Map<String, String>) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
toLaunchProductionPage(Page) - Static method in class com.adobe.cq.commerce.core.components.utils.SiteNavigation
Deprecated.
Checks if the given page is a Launch page, and if yes, returns the production version of the page.
toProductSkus(String) - Static method in class com.adobe.cq.commerce.core.components.utils.SiteNavigation
Deprecated.
Returns the base product sku and variant sku of the given combinedSku.
toProductUrl(SlingHttpServletRequest, Page, ProductUrlFormat.Params) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Returns the product page URL.
toProductUrl(SlingHttpServletRequest, Page, String) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Returns the product page URL.
toProductUrl(SlingHttpServletRequest, Page, Map<String, String>) - Method in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
toString() - Method in class com.adobe.cq.commerce.core.components.models.common.CombinedSku
 

U

uid(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.UrlProvider.ParamsBuilder
Deprecated.
UID - com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier.IdentifierType
 
UID_PARAM - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Deprecated.
URL_KEY - com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier.IdentifierType
 
URL_KEY_PARAM - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Deprecated.
URL_PATH_PARAM - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Deprecated.
UrlFormat - Interface in com.adobe.cq.commerce.core.components.services.urls
Deprecated.
urlKey(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.UrlProvider.ParamsBuilder
Deprecated.
urlPath(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.UrlProvider.ParamsBuilder
Deprecated.
UrlProvider - Interface in com.adobe.cq.commerce.core.components.services.urls
 
UrlProvider.ParamsBuilder - Class in com.adobe.cq.commerce.core.components.services.urls
Deprecated.

V

valueOf(String) - Static method in enum com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier.EntityType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier.IdentifierType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.commerce.core.components.models.product.VariantValue.SwatchType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.commerce.core.components.storefrontcontext.QueryType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.commerce.core.components.storefrontcontext.SearchFacetType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.commerce.core.components.storefrontcontext.SortDirection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.commerce.core.search.models.Sorter.Order
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier.EntityType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier.IdentifierType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.commerce.core.components.models.product.VariantValue.SwatchType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.commerce.core.components.storefrontcontext.QueryType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.commerce.core.components.storefrontcontext.SearchFacetType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.commerce.core.components.storefrontcontext.SortDirection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.commerce.core.search.models.Sorter.Order
Returns an array containing the constants of this enum type, in the order they are declared.
Variant - Interface in com.adobe.cq.commerce.core.components.models.product
Variant is a view model interface representing a product variant that contains properties specific to a variant in comparison to its base product.
VARIANT_SKU_PARAM - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Deprecated.
VARIANT_URL_KEY_PARAM - Static variable in interface com.adobe.cq.commerce.core.components.services.urls.UrlProvider
Deprecated.
VariantAttribute - Interface in com.adobe.cq.commerce.core.components.models.product
VariantAttribute is a view model interface and representing a variant axis to enable variant selection for configurable products.
variantQueryHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever
Lambda that extends the product variant query.
variantQueryHook - Variable in class com.adobe.cq.commerce.core.components.models.retriever.AbstractProductsRetriever
Lambda that extends the product variant query.
variantSku(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.UrlProvider.ParamsBuilder
Deprecated.
variantUrlKey(String) - Method in class com.adobe.cq.commerce.core.components.services.urls.UrlProvider.ParamsBuilder
Deprecated.
VariantValue - Interface in com.adobe.cq.commerce.core.components.models.product
VariantValue is a view model interface representing a possible value for a VariantAttribute.
VariantValue.SwatchType - Enum in com.adobe.cq.commerce.core.components.models.product
 
A B C D E F G H I L M N O P Q R S T U V 
All Classes All Packages