Package de.hybris.platform.cmssmarteditwebservices.products.facade

Interface ProductSearchFacade

All Known Implementing Classes:

DefaultProductSearchFacade

public interface ProductSearchFacade

Product Search Facade is a facade for searching and retrieving products and categories.

Method Summary

Modifier and Type	Method	Description
SearchResult<CategoryData>	findProductCategories(String text, PageableData pageableData)	Deprecated, for removal: This API element is subject to removal in a future version. since 2005, please use findProductCategories(String, PageableData, String)
default SearchResult<CategoryData>	findProductCategories(String text, PageableData pageableData, String langIsoCode)	Method to find product categories using a free-text form.
SearchResult<ProductData>	findProducts(String text, PageableData pageableData)	Deprecated, for removal: This API element is subject to removal in a future version. since 2005, please use findProducts(String, PageableData, String)
default SearchResult<ProductData>	findProducts(String text, PageableData pageableData, String langIsoCode)	Method to find products using a free-text form.
ProductData	getProductByUid(String uid)	Method to get a product by its product uid.
CategoryData	getProductCategoryByUid(String uid)	Method to get a category by its category uid.

Method Details

getProductByUid

ProductData getProductByUid(String uid)

Method to get a product by its product uid. It expects the base site to be previously identified using BaseSiteService.setCurrentBaseSite(String, boolean) and the catalog version to be stored in SessionService CatalogConstants.SESSION_CATALOG_VERSIONS. For your convenience, use CatalogVersionService.setSessionCatalogVersion(String, String).

Parameters:

uid - the product uid

Returns:

the Product data object.

Throws:

UnknownIdentifierException - if no Product with the specified uid is found

AmbiguousIdentifierException - if more than one Product with the specified uid is found

IllegalArgumentException - if parameter uid is null.

findProducts

@Deprecated(since="2005",
            forRemoval=true)
SearchResult<ProductData> findProducts(String text,
 PageableData pageableData)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2005, please use findProducts(String, PageableData, String)

Method to find products using a free-text form. It also supports pagination. It expects the catalog version to be stored in SessionService CatalogConstants.SESSION_CATALOG_VERSIONS. For your convenience, use CatalogVersionService.setSessionCatalogVersion(String, String).

Parameters:

text - The free-text string to be used on the product search

pageableData - the pagination object

Returns:

the search result object.

findProducts

default SearchResult<ProductData> findProducts(String text,
 PageableData pageableData,
 String langIsoCode)

Method to find products using a free-text form. It also supports pagination. It expects the catalog version to be stored in SessionService CatalogConstants.SESSION_CATALOG_VERSIONS. For your convenience, use CatalogVersionService.setSessionCatalogVersion(String, String).

Parameters:

text - The free-text string to be used on the product search

pageableData - the pagination object

langIsoCode - The language iso code to be used on product search.

Returns:

the search result object.

getProductCategoryByUid

CategoryData getProductCategoryByUid(String uid)

Method to get a category by its category uid. It expects the base site to be previously identified using BaseSiteService.setCurrentBaseSite(String, boolean) and the catalog version to be stored in SessionService CatalogConstants.SESSION_CATALOG_VERSIONS. For your convenience, use CatalogVersionService.setSessionCatalogVersion(String, String).

Parameters:

uid - the product category uid

Returns:

the Category data object containing the resulting list and the pagination object.

Throws:

UnknownIdentifierException - if no Product Category with the specified uid is found

AmbiguousIdentifierException - if more than one Product Category with the specified uid is found

IllegalArgumentException - if parameter uid is null.

findProductCategories

@Deprecated(since="2005",
            forRemoval=true)
SearchResult<CategoryData> findProductCategories(String text,
 PageableData pageableData)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2005, please use findProductCategories(String, PageableData, String)

Method to find product categories using a free-text form. It also supports pagination. It expects the catalog version to be stored in SessionService CatalogConstants.SESSION_CATALOG_VERSIONS. For your convenience, use CatalogVersionService.setSessionCatalogVersion(String, String).

Parameters:

text - The free-text string to be used on the product category search

pageableData - the pagination object

Returns:

the search result object containing the resulting list and the pagination object.

findProductCategories

default SearchResult<CategoryData> findProductCategories(String text,
 PageableData pageableData,
 String langIsoCode)

Method to find product categories using a free-text form. It also supports pagination. It expects the catalog version to be stored in SessionService CatalogConstants.SESSION_CATALOG_VERSIONS. For your convenience, use CatalogVersionService.setSessionCatalogVersion(String, String).

Parameters:

text - The free-text string to be used on the product category search

pageableData - the pagination object

langIsoCode - The language iso code to be used on category search.

Returns:

the search result object containing the resulting list and the pagination object.