Package de.hybris.platform.commercefacades.catalog

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 Detail

      • getCatalogByIdAndOptions

        CatalogData getCatalogByIdAndOptions​(java.lang.String id,
                                     java.util.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​(java.lang.String catalogId,
                                                   java.lang.String catalogVersionId,
                                                   java.util.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

        java.util.List<CatalogData> getAllCatalogsWithOptions​(java.util.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​(java.lang.String catalogId,
                                      java.lang.String catalogVersionId,
                                      java.lang.String categoryId,
                                      PageOption page,
                                      java.util.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

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

      • getProductCatalogForCurrentSite

        CatalogData getProductCatalogForCurrentSite​(java.lang.String catalogId,
                                            java.util.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​(java.lang.String catalogId,
                                                             java.lang.String catalogVersionId,
                                                             java.util.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