Interface PageRenderingService

All Known Implementing Classes:
DefaultPageRenderingService

public interface PageRenderingService
Interface responsible for retrieving page for rendering purposes.
  • Method Details

    • getPageRenderingData

      AbstractPageData getPageRenderingData(String pageTypeCode, String pageLabelOrId, String code) throws CMSItemNotFoundException
      Returns AbstractPageData object based on pageLabelOrId or code.
      Parameters:
      pageTypeCode - the page type
      pageLabelOrId - the page label or id. This field is used only when the page type is ContentPage.
      code - the code depends on the page type. If the page type is ProductPage then the code should be a product code. If the page type is CategoryPage then the code should be a category code. If the page type is CatalogPage then the code should be a catalog page.
      Returns:
      the AbstractPageData object.
      Throws:
      CMSItemNotFoundException - if the page does not exists.
    • getPageRenderingData

      AbstractPageData getPageRenderingData(String pageId) throws CMSItemNotFoundException
      Returns AbstractPageData object based on pageId.
      Parameters:
      pageId - the page id
      Returns:
      the AbstractPageData object.
      Throws:
      CMSItemNotFoundException - if the page does not exists.
    • findAllRenderingPageData

      SearchPageData<AbstractPageData> findAllRenderingPageData(String typeCode, SearchPageData searchPageData)
      Find all pages. The result is paginated. This should be used for rendering purposes.
      Parameters:
      typeCode - the page type code
      searchPageData - the pagination and sorting information
      Returns:
      a search result containing a list of AbstractPageData; can be empty, never NULL