de.hybris.platform.cmswebservices.pages.service.impl

Class ContentPageVariationResolver

java.lang.Object

de.hybris.platform.cmswebservices.pages.service.impl.ContentPageVariationResolver

All Implemented Interfaces:

PageVariationResolver<ContentPageModel>

public class ContentPageVariationResolver
extends Object
implements PageVariationResolver<ContentPageModel>

Default implementation of the PageVariationResolver. This is used for retrieving default and variation pages.

A page is considered "default":
- when its defaultPage flag is set to TRUE or
- when no default page exists for a given page type and exactly one variation page that has no restrictions exists, that variation page will be used as the default page.

A page is considered "variation" when the page has at least one restrictions assigned to it.

Constructor Summary

Constructors

Constructor and Description
ContentPageVariationResolver()

Method Summary

Modifier and Type	Method and Description
protected void	createOptionData(String value, String label, List<OptionData> options)
List<ContentPageModel>	findDefaultPages(ContentPageModel pageModel) Find default page for a given page.
protected List<ContentPageModel>	findDefaultPages(List<ContentPageModel> contentPages)
List<OptionData>	findDisplayConditions(String typeCode) Finds all display conditions available for a given page type.
List<ContentPageModel>	findPagesByType(String typeCode, boolean isDefaultPage) Find all default or variation pages for a given page type.
protected Map<String,ContentPageModel>	findUnrestrictedPages(List<ContentPageModel> contentPages)
List<ContentPageModel>	findVariationPages(ContentPageModel pageModel) Find variation pages for a given page.
protected CMSAdminPageService	getAdminPageService()
protected CMSAdminRestrictionService	getAdminRestrictionService()
boolean	isDefaultPage(ContentPageModel pageModel) Determines if a given page is a default page or a variation page.
void	setAdminPageService(CMSAdminPageService adminPageService)
void	setAdminRestrictionService(CMSAdminRestrictionService adminRestrictionService)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentPageVariationResolver

public ContentPageVariationResolver()

Method Detail

findPagesByType

public List<ContentPageModel> findPagesByType(String typeCode,
                                              boolean isDefaultPage)

Description copied from interface: PageVariationResolver

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

Specified by:

findPagesByType in interface PageVariationResolver<ContentPageModel>

Parameters:

typeCode - the page type

isDefaultPage - true to retrieve default pages; false to retrieve variation pages

Returns:

all default or variation pages

findDefaultPages

protected List<ContentPageModel> findDefaultPages(List<ContentPageModel> contentPages)

findUnrestrictedPages

protected Map<String,ContentPageModel> findUnrestrictedPages(List<ContentPageModel> contentPages)

findDefaultPages

public List<ContentPageModel> findDefaultPages(ContentPageModel pageModel)

Description copied from interface: PageVariationResolver

Find default page for a given page.

Specified by:

findDefaultPages in interface PageVariationResolver<ContentPageModel>

Parameters:

pageModel - the page

Returns:

default page (the collection should contain at most one item);
empty if the given page is a default page;
never null

findVariationPages

public List<ContentPageModel> findVariationPages(ContentPageModel pageModel)

Description copied from interface: PageVariationResolver

Find variation pages for a given page.

Specified by:

findVariationPages in interface PageVariationResolver<ContentPageModel>

Parameters:

pageModel - the page

Returns:

variation pages associated to the given page;
empty if the given page is a variation page;
never null

isDefaultPage

public boolean isDefaultPage(ContentPageModel pageModel)

Description copied from interface: PageVariationResolver

Determines if a given page is a default page or a variation page.

Specified by:

isDefaultPage in interface PageVariationResolver<ContentPageModel>

Parameters:

pageModel - the page

Returns:

true if the given page is a default page; false otherwise

findDisplayConditions

public List<OptionData> findDisplayConditions(String typeCode)

Description copied from interface: PageVariationResolver

Finds all display conditions available for a given page type. It is used to determine if a fallback and/or variation page can be created.

Specified by:

findDisplayConditions in interface PageVariationResolver<ContentPageModel>

Parameters:

typeCode - the page type

Returns:

all display conditions

createOptionData

protected void createOptionData(String value,
                                String label,
                                List<OptionData> options)

getAdminPageService

protected CMSAdminPageService getAdminPageService()

setAdminPageService

public void setAdminPageService(CMSAdminPageService adminPageService)

getAdminRestrictionService

protected CMSAdminRestrictionService getAdminRestrictionService()

setAdminRestrictionService

public void setAdminRestrictionService(CMSAdminRestrictionService adminRestrictionService)