de.hybris.platform.cms2.servicelayer.services.impl

Class DefaultCMSRestrictionService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

de.hybris.platform.cms2.servicelayer.services.impl.DefaultCMSRestrictionService

All Implemented Interfaces:

CMSRestrictionService, java.io.Serializable

Direct Known Subclasses:

RankingCMSRestrictionService

public class DefaultCMSRestrictionService
extends AbstractCMSService
implements CMSRestrictionService

Default implementation of cms restriction service which is used for evaluate restriction that is attached to page or component.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

CURRENTCATALOGVERSION, CURRENTSITE

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor and Description
DefaultCMSRestrictionService()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createMoreThanOneDefaultPageWarning(java.util.Collection<AbstractPageModel> defaultPages)
boolean	evaluate(AbstractRestrictionModel restriction, RestrictionData restrictionDataInfo) Evaluates given restriction for RestrictionData context object.
protected boolean	evaluate(java.util.List<AbstractRestrictionModel> restrictions, RestrictionData data, boolean oneRestrictionApply)
protected boolean	evaluateAnyRestriction(AbstractRestrictionModel restrictionModel, RestrictionData context)
boolean	evaluateCMSComponent(AbstractCMSComponentModel component, RestrictionData data) Evaluate cms component for RestrictionData context object.
java.util.List<AbstractCMSComponentModel>	evaluateCMSComponents(java.util.List<AbstractCMSComponentModel> components, RestrictionData data) Evaluate cms components for RestrictionData context object.
java.util.Collection<AbstractPageModel>	evaluatePages(java.util.Collection<AbstractPageModel> pages, RestrictionData data) Evaluate pages for RestrictionData context object.
java.util.Collection<java.lang.String>	getCategoryCodesForRestriction(CMSCategoryRestrictionModel restriction) Gets the category codes for restriction.
protected CatalogLevelService	getCmsCatalogLevelService()
protected java.util.Comparator<AbstractPageModel>	getCmsItemCatalogLevelComparator()
protected CMSRestrictionDao	getCmsRestrictionDao()
protected java.util.Collection<AbstractPageModel>	getDefaultPages(java.util.Collection<AbstractPageModel> pages)
protected java.util.Collection<AbstractPageModel>	getMultiCountryRestrictedPages(java.util.Collection<AbstractPageModel> pages) Finds the restriction for the given page based on catalog hierarchy defined in the context of multi-country
java.util.Collection<java.lang.String>	getProductCodesForRestriction(CMSProductRestrictionModel restriction) Gets the product codes for restriction.
protected java.util.Collection<AbstractPageModel>	getRestrictedPages(java.util.Collection<AbstractPageModel> pages, AbstractPageModel abstractPageModel, CatalogVersionModel catalogVersion) Finds pages that matches the given catalog version.
protected java.util.Collection<AbstractPageModel>	getSortedPagesByCatalogLevel(java.util.Collection<AbstractPageModel> pages) Sorts a collection of pages based on their catalog level
void	setCmsCatalogLevelService(CatalogLevelService cmsCatalogLevelService)
void	setCmsItemCatalogLevelComparator(java.util.Comparator<AbstractPageModel> cmsItemCatalogLevelComparator)
void	setCmsRestrictionDao(CMSRestrictionDao cmsRestrictionDao)
void	setEvaluatorRegistry(CMSRestrictionEvaluatorRegistry evaluatorRegistry)

Methods inherited from class de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

getBaseSiteService, getCurrentCatalogVersion, getCurrentSite, getSearchRestrictionService, getUserService, setBaseSiteService, setSearchRestrictionService, setUserService

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCMSRestrictionService

public DefaultCMSRestrictionService()

Method Detail

evaluate

public boolean evaluate(AbstractRestrictionModel restriction,
                        RestrictionData restrictionDataInfo)
                 throws RestrictionEvaluationException

Evaluates given restriction for RestrictionData context object.

Specified by:

evaluate in interface CMSRestrictionService

Parameters:

restriction - the restriction

restrictionDataInfo - the restriction data info

Returns:

true, if successful

Throws:

RestrictionEvaluationException - the restriction evaluation exception

evaluateCMSComponent

public boolean evaluateCMSComponent(AbstractCMSComponentModel component,
                                    RestrictionData data)

Evaluate cms component for RestrictionData context object.

Specified by:

evaluateCMSComponent in interface CMSRestrictionService

Parameters:

component - the component

data - the data

Returns:

true, if successful

evaluateCMSComponents

public java.util.List<AbstractCMSComponentModel> evaluateCMSComponents(java.util.List<AbstractCMSComponentModel> components,
                                                                       RestrictionData data)

Evaluate cms components for RestrictionData context object.

Specified by:

evaluateCMSComponents in interface CMSRestrictionService

Parameters:

components - the components

data - the data

Returns:

the list

evaluatePages

public java.util.Collection<AbstractPageModel> evaluatePages(java.util.Collection<AbstractPageModel> pages,
                                                             RestrictionData data)

Evaluate pages for RestrictionData context object.

Specified by:

evaluatePages in interface CMSRestrictionService

Parameters:

pages - the pages

data - the data

Returns:

the collection

getMultiCountryRestrictedPages

protected java.util.Collection<AbstractPageModel> getMultiCountryRestrictedPages(java.util.Collection<AbstractPageModel> pages)

Finds the restriction for the given page based on catalog hierarchy defined in the context of multi-country

Parameters:

pages - - the list of pages to be evaluated

Returns:

the filtered pages

getSortedPagesByCatalogLevel

protected java.util.Collection<AbstractPageModel> getSortedPagesByCatalogLevel(java.util.Collection<AbstractPageModel> pages)

Sorts a collection of pages based on their catalog level

Parameters:

pages - the unsorted collection of pages

Returns:

a sorted collection of pages

getRestrictedPages

protected java.util.Collection<AbstractPageModel> getRestrictedPages(java.util.Collection<AbstractPageModel> pages,
                                                                     AbstractPageModel abstractPageModel,
                                                                     CatalogVersionModel catalogVersion)

Finds pages that matches the given catalog version.

Parameters:

pages - - the list of pages to be filtered

abstractPageModel - - the page used for filtering (page type and labelOrId)

catalogVersion - - the catalog version used for filtering

Returns:

a list of pages

getCategoryCodesForRestriction

public java.util.Collection<java.lang.String> getCategoryCodesForRestriction(CMSCategoryRestrictionModel restriction)

Gets the category codes for restriction.

Specified by:

getCategoryCodesForRestriction in interface CMSRestrictionService

Parameters:

restriction - the restriction

Returns:

the category codes for restriction

getProductCodesForRestriction

public java.util.Collection<java.lang.String> getProductCodesForRestriction(CMSProductRestrictionModel restriction)

Gets the product codes for restriction.

Specified by:

getProductCodesForRestriction in interface CMSRestrictionService

Parameters:

restriction - the restriction

Returns:

the product codes for restriction

getCmsRestrictionDao

protected CMSRestrictionDao getCmsRestrictionDao()

setCmsRestrictionDao

public void setCmsRestrictionDao(CMSRestrictionDao cmsRestrictionDao)

setEvaluatorRegistry

public void setEvaluatorRegistry(CMSRestrictionEvaluatorRegistry evaluatorRegistry)

Parameters:

evaluatorRegistry - the evaluatorRegistry to set

evaluate

protected boolean evaluate(java.util.List<AbstractRestrictionModel> restrictions,
                           RestrictionData data,
                           boolean oneRestrictionApply)

evaluateAnyRestriction

protected boolean evaluateAnyRestriction(AbstractRestrictionModel restrictionModel,
                                         RestrictionData context)
                                  throws RestrictionEvaluationException

Throws:

RestrictionEvaluationException

getDefaultPages

protected java.util.Collection<AbstractPageModel> getDefaultPages(java.util.Collection<AbstractPageModel> pages)

createMoreThanOneDefaultPageWarning

protected java.lang.String createMoreThanOneDefaultPageWarning(java.util.Collection<AbstractPageModel> defaultPages)

getCmsCatalogLevelService

protected CatalogLevelService getCmsCatalogLevelService()

setCmsCatalogLevelService

public void setCmsCatalogLevelService(CatalogLevelService cmsCatalogLevelService)

getCmsItemCatalogLevelComparator

protected java.util.Comparator<AbstractPageModel> getCmsItemCatalogLevelComparator()

setCmsItemCatalogLevelComparator

public void setCmsItemCatalogLevelComparator(java.util.Comparator<AbstractPageModel> cmsItemCatalogLevelComparator)