Package de.hybris.platform.cmsfacades.rendering.impl

Class DefaultPageRenderingService

java.lang.Object

de.hybris.platform.cmsfacades.rendering.impl.DefaultPageRenderingService

All Implemented Interfaces:

PageRenderingService

public class DefaultPageRenderingService
extends java.lang.Object
implements PageRenderingService

Default implementation for PageRenderingService.

Constructor Summary

Constructors

Constructor	Description
DefaultPageRenderingService()

Method Summary

Modifier and Type	Method	Description
SearchPageData<AbstractPageData>	findAllRenderingPageData(java.lang.String typeCode, SearchPageData searchPageData)	Find all pages.
protected CMSDataFactory	getCmsDataFactory()
protected CMSPageService	getCmsPageService()
protected FacadeValidationService	getFacadeValidationService()
protected org.springframework.validation.Validator	getFindAllPagesRenderingPageValidator()
protected AbstractPageData	getPageData(AbstractPageModel pageModel, RestrictionData restrictionData)	Returns AbstractPageData based on AbstractPageModel and RestrictionData.
protected AbstractPageModel	getPageModel(java.lang.String pageType, java.lang.String qualifier)	Returns the AbstractPageModel.
protected Converter<AbstractPageModel,AbstractPageData>	getPageModelToDataRenderingConverter()
protected java.lang.String	getPageQualifier(java.lang.String pageLabelOrId, java.lang.String code)	Returns the qualifier that is used to extract the page.
AbstractPageData	getPageRenderingData(java.lang.String pageId)	Returns AbstractPageData object based on pageId.
AbstractPageData	getPageRenderingData(java.lang.String pageTypeCode, java.lang.String pageLabelOrId, java.lang.String code)	Returns AbstractPageData object based on pageLabelOrId or code.
RenderingCacheService<AbstractPageData>	getRenderingCacheService()
protected java.util.List<RenderingPageModelSupplier>	getRenderingPageModelSuppliers()
protected org.springframework.validation.Validator	getRenderingPageValidator()
protected RestrictionAwareService	getRestrictionAwareService()
protected RestrictionData	getRestrictionData(java.lang.String pageType, java.lang.String code)	Returns RestrictionData based on pageTypeCode and code.
void	setCmsDataFactory(CMSDataFactory cmsDataFactory)
void	setCmsPageService(CMSPageService cmsPageService)
void	setFacadeValidationService(FacadeValidationService facadeValidationService)
void	setFindAllPagesRenderingPageValidator(org.springframework.validation.Validator findAllPagesRenderingPageValidator)
void	setPageModelToDataRenderingConverter(Converter<AbstractPageModel,AbstractPageData> pageModelToDataRenderingConverter)
void	setRenderingCacheService(RenderingCacheService<AbstractPageData> renderingCacheService)
void	setRenderingPageModelSuppliers(java.util.List<RenderingPageModelSupplier> renderingPageModelSuppliers)
void	setRenderingPageValidator(org.springframework.validation.Validator renderingPageValidator)
void	setRestrictionAwareService(RestrictionAwareService restrictionAwareService)
protected void	validateParameters(java.lang.String pageTypeCode, java.lang.String pageLabelOrId, java.lang.String code)	Validates input parameters.
protected void	validateParametersForFindAllPages(java.lang.String pageTypeCode)	Validates that the provided type code represents a valid page type.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPageRenderingService

public DefaultPageRenderingService()

Method Detail

getPageRenderingData

public AbstractPageData getPageRenderingData(java.lang.String pageTypeCode,
                                             java.lang.String pageLabelOrId,
                                             java.lang.String code)
                                      throws CMSItemNotFoundException

Description copied from interface: PageRenderingService

Returns AbstractPageData object based on pageLabelOrId or code.

Specified by:

getPageRenderingData in interface PageRenderingService

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

public AbstractPageData getPageRenderingData(java.lang.String pageId)
                                      throws CMSItemNotFoundException

Description copied from interface: PageRenderingService

Returns AbstractPageData object based on pageId.

Specified by:

getPageRenderingData in interface PageRenderingService

Parameters:

pageId - the page id

Returns:

the AbstractPageData object.

Throws:

CMSItemNotFoundException - if the page does not exists.

findAllRenderingPageData

public SearchPageData<AbstractPageData> findAllRenderingPageData(java.lang.String typeCode,
                                                                 SearchPageData searchPageData)

Description copied from interface: PageRenderingService

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

Specified by:

findAllRenderingPageData in interface PageRenderingService

Parameters:

typeCode - the page type code

Returns:

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

getPageData

protected AbstractPageData getPageData(AbstractPageModel pageModel,
                                       RestrictionData restrictionData)

Returns AbstractPageData based on AbstractPageModel and RestrictionData.

Parameters:

pageModel - the AbstractPageModel.

restrictionData - the RestrictionData

Returns:

the AbstractPageData.

getRestrictionData

protected RestrictionData getRestrictionData(java.lang.String pageType,
                                             java.lang.String code)

Returns RestrictionData based on pageTypeCode and code. Never null.

Parameters:

pageType - the page type.

code - the code. 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 RestrictionData.

validateParameters

protected void validateParameters(java.lang.String pageTypeCode,
                                  java.lang.String pageLabelOrId,
                                  java.lang.String code)
                           throws CMSItemNotFoundException

Validates input parameters.

Parameters:

pageTypeCode - the page type code.

pageLabelOrId - the page label or id.

code - the code (product code, catalog code or category code)

Throws:

CMSItemNotFoundException - when the page label or id is not valid

validateParametersForFindAllPages

protected void validateParametersForFindAllPages(java.lang.String pageTypeCode)

Validates that the provided type code represents a valid page type.

Parameters:

pageTypeCode - the page type code.

getPageQualifier

protected java.lang.String getPageQualifier(java.lang.String pageLabelOrId,
                                            java.lang.String code)

Returns the qualifier that is used to extract the page.

Parameters:

pageLabelOrId - the page label or id

code - the code.

Returns:

the qualifier.

getPageModel

protected AbstractPageModel getPageModel(java.lang.String pageType,
                                         java.lang.String qualifier)
                                  throws CMSItemNotFoundException

Returns the AbstractPageModel.

Parameters:

pageType - the page type.

qualifier - the qualifier of the page. See getPageQualifier() for more information.

Returns:

the AbstractPageModel.

Throws:

CMSItemNotFoundException - if the page does not exist.

getRenderingPageModelSuppliers

protected java.util.List<RenderingPageModelSupplier> getRenderingPageModelSuppliers()

setRenderingPageModelSuppliers

public void setRenderingPageModelSuppliers(java.util.List<RenderingPageModelSupplier> renderingPageModelSuppliers)

getPageModelToDataRenderingConverter

protected Converter<AbstractPageModel,AbstractPageData> getPageModelToDataRenderingConverter()

setPageModelToDataRenderingConverter

public void setPageModelToDataRenderingConverter(Converter<AbstractPageModel,AbstractPageData> pageModelToDataRenderingConverter)

getFacadeValidationService

protected FacadeValidationService getFacadeValidationService()

setFacadeValidationService

public void setFacadeValidationService(FacadeValidationService facadeValidationService)

getRenderingPageValidator

protected org.springframework.validation.Validator getRenderingPageValidator()

setRenderingPageValidator

public void setRenderingPageValidator(org.springframework.validation.Validator renderingPageValidator)

getRestrictionAwareService

protected RestrictionAwareService getRestrictionAwareService()

setRestrictionAwareService

public void setRestrictionAwareService(RestrictionAwareService restrictionAwareService)

getCmsDataFactory

protected CMSDataFactory getCmsDataFactory()

setCmsDataFactory

public void setCmsDataFactory(CMSDataFactory cmsDataFactory)

getCmsPageService

protected CMSPageService getCmsPageService()

setCmsPageService

public void setCmsPageService(CMSPageService cmsPageService)

getRenderingCacheService

public RenderingCacheService<AbstractPageData> getRenderingCacheService()

setRenderingCacheService

public void setRenderingCacheService(RenderingCacheService<AbstractPageData> renderingCacheService)

getFindAllPagesRenderingPageValidator

protected org.springframework.validation.Validator getFindAllPagesRenderingPageValidator()

setFindAllPagesRenderingPageValidator

public void setFindAllPagesRenderingPageValidator(org.springframework.validation.Validator findAllPagesRenderingPageValidator)