Interface PageRenderingService
- All Known Implementing Classes:
DefaultPageRenderingService
public interface PageRenderingService
Interface responsible for retrieving page for rendering purposes.
-
Method Summary
Modifier and TypeMethodDescriptionfindAllRenderingPageData(String typeCode, SearchPageData searchPageData) Find all pages.getPageRenderingData(String pageId) ReturnsAbstractPageDataobject based on pageId.getPageRenderingData(String pageTypeCode, String pageLabelOrId, String code) ReturnsAbstractPageDataobject based on pageLabelOrId or code.
-
Method Details
-
getPageRenderingData
AbstractPageData getPageRenderingData(String pageTypeCode, String pageLabelOrId, String code) throws CMSItemNotFoundException ReturnsAbstractPageDataobject based on pageLabelOrId or code.- Parameters:
pageTypeCode- the page typepageLabelOrId- 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
AbstractPageDataobject. - Throws:
CMSItemNotFoundException- if the page does not exists.
-
getPageRenderingData
ReturnsAbstractPageDataobject based on pageId.- Parameters:
pageId- the page id- Returns:
- the
AbstractPageDataobject. - 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 codesearchPageData- the pagination and sorting information- Returns:
- a search result containing a list of
AbstractPageData; can be empty, neverNULL
-