Interface CatalogFacade
- All Known Implementing Classes:
DefaultCatalogFacade
public interface CatalogFacade
Catalog facade interface. Its main purpose is to retrieve catalog related DTOs using existing services.
-
Method Summary
Modifier and TypeMethodDescriptionReturns catalog DTOs for all catalogs and options (BASIC, PRODUCTS, CATEGORIES)Returns product catalogs for the current base sitegetCatalogByIdAndOptions(String id, Set<CatalogOption> options) Returns catalog DTO for catalog id and options (BASIC, PRODUCTS, CATEGORIES)getCatalogVersionByIdAndOptions(String catalogId, String catalogVersionId, Set<CatalogOption> opts) Returns catalog version DTO for catalog id, catalog version id and options (BASIC, PRODUCTS, CATEGORIES)getCategoryById(String catalogId, String catalogVersionId, String categoryId, PageOption page, Set<CatalogOption> opts) Returns category DTO for catalog id, catalog version id and category code and options (BASIC, PRODUCTS)getProductCatalogForCurrentSite(String catalogId, Set<CatalogOption> opts) Returns current base site product catalog by idgetProductCatalogVersionForTheCurrentSite(String catalogId, String catalogVersionId, Set<CatalogOption> opts) Returns catalog version DTO for catalog id, catalog version id, current base site and options (BASIC, PRODUCTS, CATEGORIES)
-
Method Details
-
getCatalogByIdAndOptions
Returns catalog DTO for catalog id and options (BASIC, PRODUCTS, CATEGORIES)- Parameters:
id- the catalog idoptions- the catalog options- Returns:
- the catalog
-
getCatalogVersionByIdAndOptions
CatalogVersionData getCatalogVersionByIdAndOptions(String catalogId, String catalogVersionId, Set<CatalogOption> opts) Returns catalog version DTO for catalog id, catalog version id and options (BASIC, PRODUCTS, CATEGORIES)- Parameters:
catalogId- the catalog idcatalogVersionId- the catalog version idopts- the catalog options- Returns:
- the catalog version
-
getAllCatalogsWithOptions
Returns catalog DTOs for all catalogs and options (BASIC, PRODUCTS, CATEGORIES)- Parameters:
opts- the catalog options- Returns:
- the
ListofCatalogData
-
getCategoryById
CategoryHierarchyData getCategoryById(String catalogId, String catalogVersionId, String categoryId, PageOption page, Set<CatalogOption> opts) Returns category DTO for catalog id, catalog version id and category code and options (BASIC, PRODUCTS)- Parameters:
catalogId- the catalog idcatalogVersionId- the catalog version idcategoryId- the category idpage- the page optionsopts- the catalog options- Returns:
- the category represented by an instance of
CategoryHierarchyData
-
getAllProductCatalogsForCurrentSite
Returns product catalogs for the current base site- Parameters:
opts- the catalog options- Returns:
- the
ListofCatalogData
-
getProductCatalogForCurrentSite
Returns current base site product catalog by id- Parameters:
catalogId- the catalog idopts- the catalog options- Returns:
- the product catalog
-
getProductCatalogVersionForTheCurrentSite
CatalogVersionData getProductCatalogVersionForTheCurrentSite(String catalogId, String catalogVersionId, Set<CatalogOption> opts) Returns catalog version DTO for catalog id, catalog version id, current base site and options (BASIC, PRODUCTS, CATEGORIES)- Parameters:
catalogId- the catalog idcatalogVersionId- the catalog version idopts- the catalog options- Returns:
- the product catalog version
-