Package de.hybris.platform.cmsfacades.pages.impl

Class DefaultPageFacade

java.lang.Object

de.hybris.platform.cmsfacades.pages.impl.DefaultPageFacade

All Implemented Interfaces:

PageFacade

public class DefaultPageFacade
extends Object
implements PageFacade

Default implementation of PageFacade.

Constructor Summary

Constructors

Constructor	Description
DefaultPageFacade()

Method Summary

Modifier and Type	Method	Description
SearchPageData<AbstractPageData>	findAllPageDataForType(String pageType, SearchPageData searchPageData)	Find all pages.
List<AbstractPageData>	findAllPages()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
List<PageTypeData>	findAllPageTypes()	Find all page types.
List<String>	findFallbackPages(String pageId)	Find all default pages for a given page.
List<AbstractPageData>	findPagesByType(String typeCode, Boolean isDefaultPage)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
List<String>	findVariationPages(String pageId)	Find all variant pages for a given page.
CMSAdminPageService	getAdminPageService()
protected CatalogVersionService	getCatalogVersionService()
protected org.springframework.validation.Validator	getCmsFindVariationPageValidator()
protected Map<String,List<String>>	getCmsItemSearchTypeBlacklistMap()
protected Comparator<AbstractPageData>	getCmsPageComparator()
CMSVersionSessionContextProvider	getCmsVersionSessionContextProvider()
protected FacadeValidationService	getFacadeValidationService()
AbstractPageData	getPageByUid(String uid)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
AbstractPageData	getPageData(String pageId)	Returns AbstractPageData object based on the pageId.
AbstractPageData	getPageData(String pageType, String pageLabelOrId, String code)	Returns AbstractPageData object based on pageLabelOrId or code.
protected AbstractPopulatingConverter<AbstractPageData,AbstractPageModel>	getPageDataConverter(Class<?> pageClass)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected Map<Class<?>,AbstractPopulatingConverter<AbstractPageData,AbstractPageModel>>	getPageDataPopulatorFactory()
protected AbstractPageModel	getPageModelById(String pageId)
protected AbstractPopulatingConverter<AbstractPageModel,AbstractPageData>	getPageModelConverter(Class<?> pageClass)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected Map<Class<?>,AbstractPopulatingConverter<AbstractPageModel,AbstractPageData>>	getPageModelConverterFactory()
protected PageRenderingService	getPageRenderingService()
protected Converter<CMSPageTypeModel,PageTypeData>	getPageTypeModelConverter()
protected PageVariationResolver<AbstractPageModel>	getPageVariationResolver(String typeCode)
protected PageVariationResolverTypeRegistry	getPageVariationResolverTypeRegistry()
PermissionCachedCRUDService	getPermissionCachedCRUDService()
protected UniqueItemIdentifierService	getUniqueItemIdentifierService()
CMSPageOperationsData	performOperation(String pageId, CMSPageOperationsData cmsPageOperationData)	Performs different operations defined by CMSPageOperation on the page such as trash page.
void	setAdminPageService(CMSAdminPageService adminPageService)
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setCmsFindVariationPageValidator(org.springframework.validation.Validator cmsFindVariationPageValidator)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
void	setCmsItemSearchTypeBlacklistMap(Map<String,List<String>> cmsItemSearchTypeBlacklistMap)
void	setCmsPageComparator(Comparator<AbstractPageData> cmsPageComparator)
void	setCmsVersionSessionContextProvider(CMSVersionSessionContextProvider cmsVersionSessionContextProvider)
void	setFacadeValidationService(FacadeValidationService facadeValidationService)
void	setPageDataPopulatorFactory(Map<Class<?>,AbstractPopulatingConverter<AbstractPageData,AbstractPageModel>> pageDataPopulatorFactory)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
void	setPageModelConverterFactory(Map<Class<?>,AbstractPopulatingConverter<AbstractPageModel,AbstractPageData>> pageModelConverterFactory)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
void	setPageRenderingService(PageRenderingService pageRenderingService)
void	setPageTypeModelConverter(Converter<CMSPageTypeModel,PageTypeData> pageTypeModelConverter)	Deprecated. since 6.6
void	setPageVariationResolverTypeRegistry(PageVariationResolverTypeRegistry pageVariationResolverTypeRegistry)
void	setPermissionCachedCRUDService(PermissionCachedCRUDService permissionCachedCRUDService)
void	setUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultPageFacade

public DefaultPageFacade()

Method Details

getPageData

public AbstractPageData getPageData(String pageType,
 String pageLabelOrId,
 String code)
                             throws CMSItemNotFoundException

Description copied from interface: PageFacade

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

Specified by:

getPageData in interface PageFacade

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

public AbstractPageData getPageData(String pageId)
                             throws CMSItemNotFoundException

Description copied from interface: PageFacade

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

Specified by:

getPageData in interface PageFacade

Parameters:

pageId - the page id

Returns:

the AbstractPageData object

Throws:

CMSItemNotFoundException - when the page does not exists

findAllPageDataForType

public SearchPageData<AbstractPageData> findAllPageDataForType(String pageType,
 SearchPageData searchPageData)

Description copied from interface: PageFacade

Find all pages. The result is paginated. This should be used for rendering purposes.

Specified by:

findAllPageDataForType in interface PageFacade

Parameters:

pageType - the page type code

searchPageData - the pagination and sorting information

Returns:

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

findAllPages

@Deprecated(since="6.6",
            forRemoval=true)
public List<AbstractPageData> findAllPages()

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

since 6.6

Find all pages.

Specified by:

findAllPages in interface PageFacade

Returns:

list of AbstractPageData ordered by title ascending; never null

findAllPageTypes

public List<PageTypeData> findAllPageTypes()

Find all page types.

Specified by:

findAllPageTypes in interface PageFacade

Returns:

list of all PageTypeData; never null

findPagesByType

@Deprecated(since="6.6",
            forRemoval=true)
public List<AbstractPageData> findPagesByType(String typeCode,
 Boolean isDefaultPage)

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

since 6.6

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

Specified by:

findPagesByType in interface PageFacade

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

public List<String> findVariationPages(String pageId)
                                throws CMSItemNotFoundException

Find all variant pages for a given page.

Specified by:

findVariationPages in interface PageFacade

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

public List<String> findFallbackPages(String pageId)
                               throws CMSItemNotFoundException

Find all default pages for a given page.

Specified by:

findFallbackPages in interface PageFacade

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(since="6.6",
            forRemoval=true)
public AbstractPageData getPageByUid(String uid)
                              throws CMSItemNotFoundException

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

since 6.6

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

Specified by:

getPageByUid in interface PageFacade

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

getPageModelById

protected AbstractPageModel getPageModelById(String pageId)
                                      throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

getPageVariationResolver

protected PageVariationResolver<AbstractPageModel> getPageVariationResolver(String typeCode)

getPageDataConverter

@Deprecated(since="6.6",
            forRemoval=true)
protected AbstractPopulatingConverter<AbstractPageData,AbstractPageModel> getPageDataConverter(Class<?> pageClass)

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

since 6.6

getPageModelConverter

@Deprecated(since="6.6",
            forRemoval=true)
protected AbstractPopulatingConverter<AbstractPageModel,AbstractPageData> getPageModelConverter(Class<?> pageClass)

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

since 6.6

getAdminPageService

public CMSAdminPageService getAdminPageService()

setAdminPageService

public void setAdminPageService(CMSAdminPageService adminPageService)

getFacadeValidationService

protected FacadeValidationService getFacadeValidationService()

setFacadeValidationService

public void setFacadeValidationService(FacadeValidationService facadeValidationService)

getPageDataPopulatorFactory

protected Map<Class<?>,AbstractPopulatingConverter<AbstractPageData,AbstractPageModel>> getPageDataPopulatorFactory()

setPageDataPopulatorFactory

@Deprecated(since="6.6",
            forRemoval=true)
public void setPageDataPopulatorFactory(Map<Class<?>,AbstractPopulatingConverter<AbstractPageData,AbstractPageModel>> pageDataPopulatorFactory)

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

since 6.6

getPageModelConverterFactory

protected Map<Class<?>,AbstractPopulatingConverter<AbstractPageModel,AbstractPageData>> getPageModelConverterFactory()

setPageModelConverterFactory

@Deprecated(since="6.6",
            forRemoval=true)
public void setPageModelConverterFactory(Map<Class<?>,AbstractPopulatingConverter<AbstractPageModel,AbstractPageData>> pageModelConverterFactory)

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

since 6.6

getPageTypeModelConverter

protected Converter<CMSPageTypeModel,PageTypeData> getPageTypeModelConverter()

setPageTypeModelConverter

@Deprecated(since="6.6")
public void setPageTypeModelConverter(Converter<CMSPageTypeModel,PageTypeData> pageTypeModelConverter)

Deprecated.

since 6.6

getCmsFindVariationPageValidator

protected org.springframework.validation.Validator getCmsFindVariationPageValidator()

setCmsFindVariationPageValidator

@Deprecated(since="6.6",
            forRemoval=true)
public void setCmsFindVariationPageValidator(org.springframework.validation.Validator cmsFindVariationPageValidator)

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

since 6.6

performOperation

public CMSPageOperationsData performOperation(String pageId,
 CMSPageOperationsData cmsPageOperationData)
                                       throws CMSItemNotFoundException

Description copied from interface: PageFacade

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

Specified by:

performOperation in interface PageFacade

Parameters:

pageId - The uid of the page.

Returns:

The CMSPageOperationsData if the operation is successful.

Throws:

CMSItemNotFoundException - when the page does not exists

getPageVariationResolverTypeRegistry

protected PageVariationResolverTypeRegistry getPageVariationResolverTypeRegistry()

setPageVariationResolverTypeRegistry

public void setPageVariationResolverTypeRegistry(PageVariationResolverTypeRegistry pageVariationResolverTypeRegistry)

getCmsPageComparator

protected Comparator<AbstractPageData> getCmsPageComparator()

setCmsPageComparator

public void setCmsPageComparator(Comparator<AbstractPageData> cmsPageComparator)

getCmsItemSearchTypeBlacklistMap

protected Map<String,List<String>> getCmsItemSearchTypeBlacklistMap()

getUniqueItemIdentifierService

protected UniqueItemIdentifierService getUniqueItemIdentifierService()

setUniqueItemIdentifierService

public void setUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService)

setCmsItemSearchTypeBlacklistMap

public void setCmsItemSearchTypeBlacklistMap(Map<String,List<String>> cmsItemSearchTypeBlacklistMap)

getPageRenderingService

protected PageRenderingService getPageRenderingService()

setPageRenderingService

public void setPageRenderingService(PageRenderingService pageRenderingService)

getCatalogVersionService

protected CatalogVersionService getCatalogVersionService()

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

getPermissionCachedCRUDService

public PermissionCachedCRUDService getPermissionCachedCRUDService()

setPermissionCachedCRUDService

public void setPermissionCachedCRUDService(PermissionCachedCRUDService permissionCachedCRUDService)

getCmsVersionSessionContextProvider

public CMSVersionSessionContextProvider getCmsVersionSessionContextProvider()

setCmsVersionSessionContextProvider

public void setCmsVersionSessionContextProvider(CMSVersionSessionContextProvider cmsVersionSessionContextProvider)