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 Details

    • getCatalogByIdAndOptions

      CatalogData getCatalogByIdAndOptions(String id, Set<CatalogOption> options)
      Returns catalog DTO for catalog id and options (BASIC, PRODUCTS, CATEGORIES)
      Parameters:
      id - the catalog id
      options - 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 id
      catalogVersionId - the catalog version id
      opts - the catalog options
      Returns:
      the catalog version
    • getAllCatalogsWithOptions

      List<CatalogData> getAllCatalogsWithOptions(Set<CatalogOption> opts)
      Returns catalog DTOs for all catalogs and options (BASIC, PRODUCTS, CATEGORIES)
      Parameters:
      opts - the catalog options
      Returns:
      the List of CatalogData
    • 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 id
      catalogVersionId - the catalog version id
      categoryId - the category id
      page - the page options
      opts - the catalog options
      Returns:
      the category represented by an instance of CategoryHierarchyData
    • getAllProductCatalogsForCurrentSite

      List<CatalogData> getAllProductCatalogsForCurrentSite(Set<CatalogOption> opts)
      Returns product catalogs for the current base site
      Parameters:
      opts - the catalog options
      Returns:
      the List of CatalogData
    • getProductCatalogForCurrentSite

      CatalogData getProductCatalogForCurrentSite(String catalogId, Set<CatalogOption> opts)
      Returns current base site product catalog by id
      Parameters:
      catalogId - the catalog id
      opts - 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 id
      catalogVersionId - the catalog version id
      opts - the catalog options
      Returns:
      the product catalog version