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 TypeMethodDescriptionfindProductCategories(String text, PageableData pageableData) Method to find product categories using a free-text form.findProducts(String text, PageableData pageableData) Method to find products using a free-text form.getProductByCode(String code) Method to get a product by its product code.Method to get a category by its category code.
-
Method Details
-
getProductByCode
Method to get a product by its product code. It expects the base site to be previously identified usingBaseSiteService.setCurrentBaseSite(String, boolean)and the catalog version to be stored inSessionServiceCatalogConstants.SESSION_CATALOG_VERSIONS. For your convenience, useCatalogVersionService.setSessionCatalogVersion(String, String).- Parameters:
code- the product code- Returns:
- the Product data object.
- Throws:
UnknownIdentifierException- if no Product with the specified code is foundAmbiguousIdentifierException- if more than one Product with the specified code is foundIllegalArgumentException- if parameter code isnull.
-
findProducts
Method to find products using a free-text form. It also supports pagination. It expects the base site to be previously identified usingBaseSiteService.setCurrentBaseSite(String, boolean)and the catalog version to be stored inSessionServiceCatalogConstants.SESSION_CATALOG_VERSIONS. For your convenience, useCatalogVersionService.setSessionCatalogVersion(String, String).- Parameters:
text- The free-text string to be used on the product searchpageableData- the pagination object- Returns:
- the search result object.
-
getProductCategoryByCode
Method to get a category by its category code. It expects the base site to be previously identified usingBaseSiteService.setCurrentBaseSite(String, boolean)and the catalog version to be stored inSessionServiceCatalogConstants.SESSION_CATALOG_VERSIONS. For your convenience, useCatalogVersionService.setSessionCatalogVersion(String, String).- Parameters:
code- the product category code- Returns:
- the Category data object containing the resulting list and the pagination object.
- Throws:
UnknownIdentifierException- if no Product Category with the specified code is foundAmbiguousIdentifierException- if more than one Product Category with the specified code is foundIllegalArgumentException- if parameter code isnull.
-
findProductCategories
Method to find product categories using a free-text form. It also supports pagination. It expects the base site to be previously identified usingBaseSiteService.setCurrentBaseSite(String, boolean)and the catalog version to be stored inSessionServiceCatalogConstants.SESSION_CATALOG_VERSIONS. For your convenience, useCatalogVersionService.setSessionCatalogVersion(String, String).- Parameters:
text- The free-text string to be used on the product category searchpageableData- the pagination object- Returns:
- the search result object containing the resulting list and the pagination object.
-