Package de.hybris.platform.cms2.servicelayer.services

Interface CMSPageService

All Known Subinterfaces:

VendorCMSPageService

All Known Implementing Classes:

DefaultCMSPageService, DefaultVendorCMSPageService

public interface CMSPageService

The Interface CMSPageService. Provides methods for managing pages or page templates.

Spring Bean ID:

cmsPageService

Method Summary

Modifier and Type	Method	Description
SearchPageData<AbstractPageModel>	findAllPages(String typeCode, SearchPageData searchPageData)	Find all pages.
Collection<PageTemplateModel>	getAllActivePageTemplates()	Gets the all active page templates.
Collection<ContentPageModel>	getAllContentPages()	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, no longer needed
default List<ContentSlotForTemplateModel>	getChildSlotForTemplateAtSamePosition(Collection<ContentSlotForTemplateModel> slotForTemplateModels)	For multi-country the same position may have multi slotForTemplate, this function will get the child catalogVersion of slotForTemplateModel and remove other parents slotForTemplates.
ContentSlotData	getContentSlotForPage(AbstractPageModel page, String position)	Returns a contentslot for the given page and position.
ContentSlotData	getContentSlotForPage(AbstractPageModel page, String position, PagePreviewCriteriaData pagePreviewCriteria)	Deprecated, for removal: This API element is subject to removal in a future version. since 2105, no longer needed.
Collection<ContentSlotForPageModel>	getContentSlotModelsForPage(AbstractPageModel page, PagePreviewCriteriaData pagePreviewCriteria)	Deprecated, for removal: This API element is subject to removal in a future version. since 2105, no longer needed.
Collection<ContentSlotData>	getContentSlotsForPage(AbstractPageModel page)	Returns collection of ContentSlotData objects containing data taken from all ContentSlotForPageModel objects as well from ContentSlotForTemplateModel objects for passed as parameter AbstractPageModel object.
Collection<ContentSlotData>	getContentSlotsForPage(AbstractPageModel page, PagePreviewCriteriaData pagePreviewCriteria)	Returns collection of ContentSlotData objects containing data taken from all ContentSlotForPageModel objects as well from ContentSlotForTemplateModel objects for a given AbstractPageModel and PagePreviewCriteriaData.
Collection<ContentSlotForTemplateModel>	getContentSlotsForPageTemplate(PageTemplateModel pageTemplate)	Gets all ContentSlotForTemplateModel objects related to passed as parameter PageTemplateModel.
CatalogPageModel	getDefaultCatalogPage()	Returns the default catalog page WITHOUT evaluating any restrictions
CategoryPageModel	getDefaultCategoryPage()	Returns the default category page WITHOUT evaluating any restrictions
ContentPageModel	getDefaultPageForLabel(String label, CatalogVersionModel version)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, please use CMSContentPageService.getDefaultPageForLabel(String, CatalogVersionModel) instead
ProductPageModel	getDefaultProductPage()	Returns the default product page WITHOUT evaluating any restrictions
String	getFrontendTemplateName(PageTemplateModel template)	Gets the frontend template name for PageTemplateModel object.
ContentPageModel	getHomepage()	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, please use CMSContentPageService.getHomepage() instead
ContentPageModel	getHomepage(PagePreviewCriteriaData pagePreviewCriteria)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, please use CMSContentPageService.getHomepage(PagePreviewCriteriaData) instead
String	getLabelOrId(ContentPageModel contentPage)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, no longer needed
Collection<ContentSlotForPageModel>	getOwnContentSlotsForPage(AbstractPageModel page)	Returns the ContentSlotForPageModel objects for passed as parameter AbstractPageModel object.
CatalogPageModel	getPageForCatalog(CatalogModel catalog)	Gets the page by catalog.
CatalogPageModel	getPageForCatalogId(String catalogId)	Gets the page for catalog id.
CategoryPageModel	getPageForCategory(CategoryModel category)	Gets the page for category.
CategoryPageModel	getPageForCategory(CategoryModel category, PagePreviewCriteriaData pagePreviewCriteria)	Gets the page for category and PagePreviewCriteriaData.
CategoryPageModel	getPageForCategoryCode(String categoryCode)	Gets the page for category code.
CategoryPageModel	getPageForCategoryCode(String categoryCode, PagePreviewCriteriaData pagePreviewCriteria)	Gets the page for category code and PagePreviewCriteriaData.
AbstractPageModel	getPageForId(String id)	Gets the page for id.
AbstractPageModel	getPageForId(String id, PagePreviewCriteriaData pagePreviewCriteria)	Gets the page for id and PagePreviewCriteriaData.
AbstractPageModel	getPageForIdWithRestrictions(String id)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, no longer needed
ContentPageModel	getPageForLabel(String label)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, please use CMSContentPageService.getPageForLabelAndStatuses(String, List) instead
ContentPageModel	getPageForLabel(String label, PagePreviewCriteriaData pagePreviewCriteria)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, please use CMSContentPageService.getPageForLabelAndPreview(String, PagePreviewCriteriaData) instead
ContentPageModel	getPageForLabelAndPageStatuses(String label, List<CmsPageStatus> pageStatuses)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, please use CMSContentPageService.getPageForLabelAndStatuses(String, List) instead
ContentPageModel	getPageForLabelOrId(String labelOrId)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, please use CMSContentPageService.getPageForLabelOrIdAndMatchType(String, boolean) instead
ContentPageModel	getPageForLabelOrId(String labelOrId, PagePreviewCriteriaData pagePreviewCriteria)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905, please use CMSContentPageService.getPageForLabelOrIdAndMatchType(String, PagePreviewCriteriaData, boolean) instead
ProductPageModel	getPageForProduct(ProductModel product)	Gets the page for product.
ProductPageModel	getPageForProduct(ProductModel product, PagePreviewCriteriaData pagePreviewCriteria)	Gets the page for product and PagePreviewCriteriaData.
ProductPageModel	getPageForProductCode(String productCode)	Gets the page for product code.
ProductPageModel	getPageForProductCode(String productCode, PagePreviewCriteriaData pagePreviewCriteria)	Gets the page for product code and PagePreviewCriteriaData.
Collection<AbstractPageModel>	getPagesForComponent(AbstractCMSComponentModel component)	Returns all pages where given component occurs.
Collection<AbstractPageModel>	getPagesForContentSlots(Collection<ContentSlotModel> contentSlots)	Returns all pages where given content slots occurs.
Collection<AbstractPageModel>	getPagesForPageTemplateComponent(AbstractCMSComponentModel component)	Gets the pages for page template component.
Collection<AbstractPageModel>	getPagesForPageTemplateContentSlots(Collection<ContentSlotModel> contentSlots)	Gets the pages for page template content slots.
List<ContentSlotModel>	getSortedMultiCountryContentSlots(List<ContentSlotModel> contentSlots, List<CatalogVersionModel> catalogVersions)	Deprecated, for removal: This API element is subject to removal in a future version. since 2105, please use getSortedMultiCountryContentSlots(List, List, AbstractPageModel)
List<ContentSlotModel>	getSortedMultiCountryContentSlots(List<ContentSlotModel> contentSlots, List<CatalogVersionModel> catalogVersions, AbstractPageModel page)	Gets the content slots sorted by their catalog hierarchy.

Method Details

getAllActivePageTemplates

Collection<PageTemplateModel> getAllActivePageTemplates()

Gets the all active page templates.

Returns:

the all active page templates

getAllContentPages

@Deprecated(since="1905",
            forRemoval=true)
Collection<ContentPageModel> getAllContentPages()

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, no longer needed

Gets the all content pages.

Returns:

the all content pages

getOwnContentSlotsForPage

Collection<ContentSlotForPageModel> getOwnContentSlotsForPage(AbstractPageModel page)

Returns the ContentSlotForPageModel objects for passed as parameter AbstractPageModel object.

Parameters:

page - the AbstractPageModel object.

Returns:

collection of ContentSlotForPageModel objects related to AbstractPageModel.

getContentSlotModelsForPage

@Deprecated(since="2105",
            forRemoval=true)
Collection<ContentSlotForPageModel> getContentSlotModelsForPage(AbstractPageModel page,
 PagePreviewCriteriaData pagePreviewCriteria)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2105, no longer needed.

Returns the ContentSlotForPageModel objects for passed as parameter AbstractPageModel object and PagePreviewCriteriaData.

Parameters:

page - the AbstractPageModel object.

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

collection of ContentSlotForPageModel objects related to AbstractPageModel.

getContentSlotForPage

ContentSlotData getContentSlotForPage(AbstractPageModel page,
 String position)
                               throws CMSItemNotFoundException

Returns a contentslot for the given page and position. WARNING: This could be a performance issue when you select all content slots of a page via this method. A better way is to set all contentslots via getContentSlotsForPage(AbstractPageModel page) and set them in the request scope

Parameters:

page - the page model

position - the position

Returns:

contentslot for the given page and position.

Throws:

CMSItemNotFoundException - if no content slot is defined at this position in that page

getContentSlotForPage

@Deprecated(since="2105",
            forRemoval=true)
ContentSlotData getContentSlotForPage(AbstractPageModel page,
 String position,
 PagePreviewCriteriaData pagePreviewCriteria)
                               throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 2105, no longer needed.

Returns a contentslot for the given page, position and PagePreviewCriteriaData. WARNING: This could be a performance issue when you select all content slots of a page via this method. A better way is to set all contentslots via getContentSlotsForPage(AbstractPageModel page) and set them in the request scope

Parameters:

page - the page model

position - the position

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

contentslot for the given page and position.

Throws:

CMSItemNotFoundException - if no content slot is defined at this position in that page

getContentSlotsForPage

Collection<ContentSlotData> getContentSlotsForPage(AbstractPageModel page)

Returns collection of ContentSlotData objects containing data taken from all ContentSlotForPageModel objects as well from ContentSlotForTemplateModel objects for passed as parameter AbstractPageModel object.

Parameters:

page - the AbstractPageModel object.

Returns:

collection of ContentSlotData objects.

getContentSlotsForPage

Collection<ContentSlotData> getContentSlotsForPage(AbstractPageModel page,
 PagePreviewCriteriaData pagePreviewCriteria)

Returns collection of ContentSlotData objects containing data taken from all ContentSlotForPageModel objects as well from ContentSlotForTemplateModel objects for a given AbstractPageModel and PagePreviewCriteriaData.

Parameters:

page - the AbstractPageModel object.

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

collection of ContentSlotData objects.

getContentSlotsForPageTemplate

Collection<ContentSlotForTemplateModel> getContentSlotsForPageTemplate(PageTemplateModel pageTemplate)

Gets all ContentSlotForTemplateModel objects related to passed as parameter PageTemplateModel.

Parameters:

pageTemplate - the PageTemplateModel object for which search will be executed.

Returns:

the list of found ContentSlotForTemplateModel objects.

getDefaultCatalogPage

CatalogPageModel getDefaultCatalogPage()
                                throws CMSItemNotFoundException

Returns the default catalog page WITHOUT evaluating any restrictions

Returns:

default catalog page

Throws:

CMSItemNotFoundException - if no default catalog page could be found

getDefaultCategoryPage

CategoryPageModel getDefaultCategoryPage()
                                  throws CMSItemNotFoundException

Returns the default category page WITHOUT evaluating any restrictions

Returns:

default category page

Throws:

CMSItemNotFoundException - if no default category page could be found

getDefaultPageForLabel

@Deprecated(since="1905",
            forRemoval=true)
ContentPageModel getDefaultPageForLabel(String label,
 CatalogVersionModel version)
                                 throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, please use CMSContentPageService.getDefaultPageForLabel(String, CatalogVersionModel) instead

Gets the default page by label and catalog version.

Parameters:

label - the label

version - the version

Returns:

the default page by label

Throws:

CMSItemNotFoundException - thrown when item was not found

getDefaultProductPage

ProductPageModel getDefaultProductPage()
                                throws CMSItemNotFoundException

Returns the default product page WITHOUT evaluating any restrictions

Returns:

default product page

Throws:

CMSItemNotFoundException - if no default product page could be found

getFrontendTemplateName

String getFrontendTemplateName(PageTemplateModel template)

Gets the frontend template name for PageTemplateModel object.

Parameters:

template - the PageTemplateModel object.

Returns:

the frontend template name.

getHomepage

@Deprecated(since="1905",
            forRemoval=true)
ContentPageModel getHomepage()

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, please use CMSContentPageService.getHomepage() instead

Gets the homepage

Returns:

the homepage model

getHomepage

@Deprecated(since="1905",
            forRemoval=true)
ContentPageModel getHomepage(PagePreviewCriteriaData pagePreviewCriteria)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, please use CMSContentPageService.getHomepage(PagePreviewCriteriaData) instead

Returns homepage for PagePreviewCriteriaData.

Parameters:

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the homepage model

getLabelOrId

@Deprecated(since="1905",
            forRemoval=true)
String getLabelOrId(ContentPageModel contentPage)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, no longer needed

Gets the ContentPageModel label or id if label is empty.

Parameters:

contentPage - the ContentPageModel object.

Returns:

the label or id of ContentPageModel.

getPageForCatalog

CatalogPageModel getPageForCatalog(CatalogModel catalog)
                            throws CMSItemNotFoundException

Gets the page by catalog.

Parameters:

catalog - the catalog

Returns:

the page by catalog

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForCatalogId

CatalogPageModel getPageForCatalogId(String catalogId)
                              throws CMSItemNotFoundException

Gets the page for catalog id.

Parameters:

catalogId - the catalog id

Returns:

the page for catalog id

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForCategory

CategoryPageModel getPageForCategory(CategoryModel category)
                              throws CMSItemNotFoundException

Gets the page for category.

Parameters:

category - the category

Returns:

the page for category

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForCategory

CategoryPageModel getPageForCategory(CategoryModel category,
 PagePreviewCriteriaData pagePreviewCriteria)
                              throws CMSItemNotFoundException

Gets the page for category and PagePreviewCriteriaData.

Parameters:

category - the category

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for category

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForCategoryCode

CategoryPageModel getPageForCategoryCode(String categoryCode)
                                  throws CMSItemNotFoundException

Gets the page for category code.

Parameters:

categoryCode - the category code

Returns:

the page for category code

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForCategoryCode

CategoryPageModel getPageForCategoryCode(String categoryCode,
 PagePreviewCriteriaData pagePreviewCriteria)
                                  throws CMSItemNotFoundException

Gets the page for category code and PagePreviewCriteriaData.

Parameters:

categoryCode - the category code

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for category code

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForId

AbstractPageModel getPageForId(String id)
                        throws CMSItemNotFoundException

Gets the page for id.

Parameters:

id - the id

Returns:

the page for id

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForIdWithRestrictions

@Deprecated(since="1905",
            forRemoval=true)
AbstractPageModel getPageForIdWithRestrictions(String id)
                                        throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, no longer needed

Gets the page for id and evaluates the page restrictions

Parameters:

id - the id

Returns:

the page for id

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForId

AbstractPageModel getPageForId(String id,
 PagePreviewCriteriaData pagePreviewCriteria)
                        throws CMSItemNotFoundException

Gets the page for id and PagePreviewCriteriaData.

Parameters:

id - the id

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for id

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForLabel

@Deprecated(since="1905",
            forRemoval=true)
ContentPageModel getPageForLabel(String label)
                          throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, please use CMSContentPageService.getPageForLabelAndStatuses(String, List) instead

Gets the page for label.

Parameters:

label - the label

Returns:

the page for label

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForLabel

@Deprecated(since="1905",
            forRemoval=true)
ContentPageModel getPageForLabel(String label,
 PagePreviewCriteriaData pagePreviewCriteria)
                          throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, please use CMSContentPageService.getPageForLabelAndPreview(String, PagePreviewCriteriaData) instead

Gets the page for label and PagePreviewCriteriaData.

Parameters:

label - the label

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for label

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForLabelAndPageStatuses

@Deprecated(since="1905",
            forRemoval=true)
ContentPageModel getPageForLabelAndPageStatuses(String label,
 List<CmsPageStatus> pageStatuses)
                                         throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, please use CMSContentPageService.getPageForLabelAndStatuses(String, List) instead

Gets the page for label by page status.

Parameters:

label - the label

pageStatuses - the page statuses. i.e. (deleted, active)

Returns:

the page for label

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForLabelOrId

@Deprecated(since="1905",
            forRemoval=true)
ContentPageModel getPageForLabelOrId(String labelOrId)
                              throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, please use CMSContentPageService.getPageForLabelOrIdAndMatchType(String, boolean) instead

Gets the page for label or id.

Parameters:

labelOrId - the label or id

Returns:

the page for label or id

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForLabelOrId

@Deprecated(since="1905",
            forRemoval=true)
ContentPageModel getPageForLabelOrId(String labelOrId,
 PagePreviewCriteriaData pagePreviewCriteria)
                              throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905, please use CMSContentPageService.getPageForLabelOrIdAndMatchType(String, PagePreviewCriteriaData, boolean) instead

Gets the page for label or id and PagePreviewCriteriaData.

Parameters:

labelOrId - the label or id

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for label or id

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForProduct

ProductPageModel getPageForProduct(ProductModel product)
                            throws CMSItemNotFoundException

Gets the page for product.

Parameters:

product - the product

Returns:

the page for product

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForProduct

ProductPageModel getPageForProduct(ProductModel product,
 PagePreviewCriteriaData pagePreviewCriteria)
                            throws CMSItemNotFoundException

Gets the page for product and PagePreviewCriteriaData.

Parameters:

product - the product

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for product

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForProductCode

ProductPageModel getPageForProductCode(String productCode)
                                throws CMSItemNotFoundException

Gets the page for product code.

Parameters:

productCode - the product code

Returns:

the page for product code

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForProductCode

ProductPageModel getPageForProductCode(String productCode,
 PagePreviewCriteriaData pagePreviewCriteria)
                                throws CMSItemNotFoundException

Gets the page for product code and PagePreviewCriteriaData.

Parameters:

productCode - the product code

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for product code

Throws:

CMSItemNotFoundException - thrown when item is not found

getPagesForComponent

Collection<AbstractPageModel> getPagesForComponent(AbstractCMSComponentModel component)

Returns all pages where given component occurs.

Parameters:

component - - component model that we are looking pages for

Returns:

- collection of AbstractPageModel

getPagesForContentSlots

Collection<AbstractPageModel> getPagesForContentSlots(Collection<ContentSlotModel> contentSlots)

Returns all pages where given content slots occurs.

Parameters:

contentSlots - - content slot model that we are looking pages for

Returns:

- collection of AbstractPageModel

getPagesForPageTemplateComponent

Collection<AbstractPageModel> getPagesForPageTemplateComponent(AbstractCMSComponentModel component)

Gets the pages for page template component.

Parameters:

component - the component

Returns:

the pages for page template component

getPagesForPageTemplateContentSlots

Collection<AbstractPageModel> getPagesForPageTemplateContentSlots(Collection<ContentSlotModel> contentSlots)

Gets the pages for page template content slots.

Parameters:

contentSlots - the content slots

Returns:

the pages for page template content slots

getSortedMultiCountryContentSlots

@Deprecated(since="2105",
            forRemoval=true)
List<ContentSlotModel> getSortedMultiCountryContentSlots(List<ContentSlotModel> contentSlots,
 List<CatalogVersionModel> catalogVersions)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2105, please use getSortedMultiCountryContentSlots(List, List, AbstractPageModel)

Gets the content slots sorted by their catalog hierarchy.

Parameters:

contentSlots - - the content slots

catalogVersions - - the catalog versions

Returns:

a sorted list of content slots

getSortedMultiCountryContentSlots

List<ContentSlotModel> getSortedMultiCountryContentSlots(List<ContentSlotModel> contentSlots,
 List<CatalogVersionModel> catalogVersions,
 AbstractPageModel page)

Gets the content slots sorted by their catalog hierarchy.

Parameters:

contentSlots - - the content slots

catalogVersions - - the catalog versions

page - - original page

Returns:

a sorted list of ContentSlotModel, empty list of not found.

findAllPages

SearchPageData<AbstractPageModel> findAllPages(String typeCode,
 SearchPageData searchPageData)

Find all pages. The result is paginated.

Parameters:

typeCode - the page type code

searchPageData - the pagination and sorting information

Returns:

a search result containing a list of AbstractPageModel; can be empty, never NULL

getChildSlotForTemplateAtSamePosition

default List<ContentSlotForTemplateModel> getChildSlotForTemplateAtSamePosition(Collection<ContentSlotForTemplateModel> slotForTemplateModels)

For multi-country the same position may have multi slotForTemplate, this function will get the child catalogVersion of slotForTemplateModel and remove other parents slotForTemplates.

Parameters:

slotForTemplateModels - the list of ContentSlotForTemplateModel may have multi slotForTemplate in same position

Returns:

the ContentSlotForTemplateModel