Package de.hybris.platform.cmsfacades.pages

Interface PageFacade

All Known Implementing Classes:

DefaultPageFacade

public interface PageFacade

Component facade interface which deals with methods related to page operations.

Method Summary

Modifier and Type	Method	Description
java.util.List<AbstractPageData>	findAllPages()	Deprecated. since 6.6.
java.util.List<PageTypeData>	findAllPageTypes()	Find all page types.
java.util.List<java.lang.String>	findFallbackPages(java.lang.String pageId)	Find all default pages for a given page.
java.util.List<AbstractPageData>	findPagesByType(java.lang.String typeCode, java.lang.Boolean isDefaultPage)	Deprecated. since 6.6.
java.util.List<java.lang.String>	findVariationPages(java.lang.String pageId)	Find all variant pages for a given page.
AbstractPageData	getPageByUid(java.lang.String uid)	Deprecated. since 6.6.
AbstractPageData	getPageData(java.lang.String pageId)	Returns AbstractPageData object based on the pageId.
AbstractPageData	getPageData(java.lang.String pageType, java.lang.String pageLabelOrId, java.lang.String code)	Returns AbstractPageData object based on pageLabelOrId or code.
CMSPageOperationsData	performOperation(java.lang.String pageId, CMSPageOperationsData cmsPageOperationData)	Performs different operations defined by CMSPageOperation on the page such as trash page.

Method Detail

findAllPages

@Deprecated
java.util.List<AbstractPageData> findAllPages()

Deprecated.

since 6.6. Please use CMSItemFacade.findCMSItems(de.hybris.platform.cmsfacades.data.CMSItemSearchData, PageableData) instead.

Find all pages.

Returns:

list of AbstractPageData ordered by title ascending; never null

findAllPageTypes

java.util.List<PageTypeData> findAllPageTypes()

Find all page types.

Returns:

list of all PageTypeData; never null

findPagesByType

@Deprecated
java.util.List<AbstractPageData> findPagesByType(java.lang.String typeCode,
                                                 java.lang.Boolean isDefaultPage)

Deprecated.

since 6.6. Please use CMSItemFacade.findCMSItems(de.hybris.platform.cmsfacades.data.CMSItemSearchData, PageableData) instead.

Find all default or variant pages for a given page type.

Parameters:

typeCode - - the page typecode

isDefaultPage - - set to true to find all default pages; set to false to find all variant pages

Returns:

list of default or variant AbstractPageData ordered by name ascending; never null

findVariationPages

java.util.List<java.lang.String> findVariationPages(java.lang.String pageId)
                                             throws CMSItemNotFoundException

Find all variant pages for a given page.

Parameters:

pageId - - the page identifier

Returns:

list of variation page uids; empty if the given page is already a variation page; never null

Throws:

CMSItemNotFoundException - when the page could not be found

findFallbackPages

java.util.List<java.lang.String> findFallbackPages(java.lang.String pageId)
                                            throws CMSItemNotFoundException

Find all default pages for a given page.

Parameters:

pageId - - the page identifier

Returns:

list of default page uids; empty if the given page is already a default page; never null

Throws:

CMSItemNotFoundException - when the page could not be found

getPageByUid

@Deprecated
AbstractPageData getPageByUid(java.lang.String uid)
                       throws CMSItemNotFoundException

Deprecated.

since 6.6. Please use CMSItemFacade.getCMSItemByUuid(String) instead.

Find a single page by its uid. This should be used for management purposes.

Parameters:

uid - - the uid of the page to retrieve.

Returns:

the page matching the given uid

Throws:

CMSItemNotFoundException - when the page could not be found

getPageData

AbstractPageData getPageData(java.lang.String pageType,
                             java.lang.String pageLabelOrId,
                             java.lang.String code)
                      throws CMSItemNotFoundException

Returns AbstractPageData object based on pageLabelOrId or code. This should be used for rendering purposes.

Parameters:

pageType - 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 - when the page does not exists

getPageData

AbstractPageData getPageData(java.lang.String pageId)
                      throws CMSItemNotFoundException

Returns AbstractPageData object based on the pageId. This should be used for rendering purposes.

Parameters:

pageId - the page id

Returns:

the AbstractPageData object

Throws:

CMSItemNotFoundException - when the page does not exists

performOperation

CMSPageOperationsData performOperation(java.lang.String pageId,
                                       CMSPageOperationsData cmsPageOperationData)
                                throws CMSItemNotFoundException

Performs different operations defined by CMSPageOperation on the page such as trash page.

Parameters:

pageId - The uid of the page.

cmsWorkflowOperationData - The CMSPageOperationsData containing the data to perform the operation.

Returns:

The CMSPageOperationsData if the operation is successful.

Throws:

CMSItemNotFoundException - when the page does not exists