Package com.adobe.cq.commerce.core.components.models.productlist

Interface ProductList

All Superinterfaces:

com.adobe.cq.wcm.core.components.models.Component, com.adobe.cq.export.json.ComponentExporter, PageMetadata, ProductCollection

All Known Implementing Classes:

ProductListImpl

public interface ProductList
extends com.adobe.cq.wcm.core.components.models.Component, ProductCollection, PageMetadata

Field Summary

Fields

Modifier and Type	Field	Description
static String	PN_SHOW_IMAGE	Name of the boolean resource property indicating if the product list should render the category image.
static String	PN_SHOW_TITLE	Name of the boolean resource property indicating if the product list should render the category title.

Fields inherited from interface com.adobe.cq.wcm.core.components.models.Component

PN_ID

Fields inherited from interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection

PN_LOAD_CLIENT_PRICE, PN_PAGE_SIZE, PN_PAGINATION_TYPE

Method Summary

Modifier and Type	Method	Description
AbstractCategoryRetriever	getCategoryRetriever()	Returns in instance of the category retriever for fetching category data via GraphQL.
String	getImage()
String	getTitle()	Returns the title of this ProductList.
boolean	showImage()
boolean	showTitle()	Returns true if the category / product list title should be rendered.

Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component

getData, getExportedType, getId

Methods inherited from interface com.adobe.cq.commerce.core.components.models.page.PageMetadata

getCanonicalUrl, getMetaDescription, getMetaKeywords, getMetaTitle

Methods inherited from interface com.adobe.cq.commerce.core.components.models.productcollection.ProductCollection

getPaginationType, getProducts, getSearchResultsSet, loadClientPrice

Field Detail

PN_SHOW_TITLE

static final String PN_SHOW_TITLE

Name of the boolean resource property indicating if the product list should render the category title.

See Also:

Constant Field Values

PN_SHOW_IMAGE

static final String PN_SHOW_IMAGE

Name of the boolean resource property indicating if the product list should render the category image.

See Also:

Constant Field Values

Method Detail

showTitle

boolean showTitle()

Returns true if the category / product list title should be rendered.

Returns:

true if category / product list title should be shown, false otherwise

getTitle

@Nullable
String getTitle()

Returns the title of this ProductList.

Returns:

the title of this list item or null

getImage

String getImage()

showImage

boolean showImage()

getCategoryRetriever

AbstractCategoryRetriever getCategoryRetriever()

Returns in instance of the category retriever for fetching category data via GraphQL.

Returns:

category retriever instance