de.hybris.platform.cms2.servicelayer.services

Interface CMSRestrictionService

All Known Implementing Classes:

DefaultCMSRestrictionService, RankingCMSRestrictionService

public interface CMSRestrictionService

The Interface CMSRestrictionService. Provides methods for managing CMS2 restrictions.

Spring Bean ID:

cmsRestrictionService

Method Summary

Modifier and Type	Method and Description
boolean	evaluate(AbstractRestrictionModel restriction, RestrictionData restrictionDataInfo) Evaluates given restriction for RestrictionData context object.
boolean	evaluate(CMSCatalogRestrictionModel restriction, RestrictionData data) Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.
boolean	evaluate(CMSCategoryRestrictionModel restriction, RestrictionData data) Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.
boolean	evaluate(CMSProductRestrictionModel restriction, RestrictionData data) Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.
boolean	evaluate(CMSTimeRestrictionModel restriction) Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.
boolean	evaluate(CMSUserGroupRestrictionModel restriction) Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.
boolean	evaluate(CMSUserRestrictionModel restriction) Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.
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.
java.util.Collection<java.lang.String>	getProductCodesForRestriction(CMSProductRestrictionModel restriction) Gets the product codes for restriction.

Method Detail

evaluate

boolean evaluate(AbstractRestrictionModel restriction,
                 RestrictionData restrictionDataInfo)
          throws RestrictionEvaluationException

Evaluates given restriction for RestrictionData context object.

Parameters:

restriction - the restriction

restrictionDataInfo - the restriction data info

Returns:

true, if successful

Throws:

RestrictionEvaluationException - the restriction evaluation exception

evaluate

@Deprecated
boolean evaluate(CMSCatalogRestrictionModel restriction,
                             RestrictionData data)
                      throws RestrictionEvaluationException

Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.

Evaluates given restriction for RestrictionData context object.

Parameters:

restriction - the restriction

data - the data

Returns:

true, if successful

Throws:

RestrictionEvaluationException - the restriction evaluation exception

evaluate

@Deprecated
boolean evaluate(CMSCategoryRestrictionModel restriction,
                             RestrictionData data)
                      throws RestrictionEvaluationException

Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.

Evaluates given restriction for RestrictionData context object.

Parameters:

restriction - the restriction

data - the data

Returns:

true, if successful

Throws:

RestrictionEvaluationException - the restriction evaluation exception

evaluate

@Deprecated
boolean evaluate(CMSProductRestrictionModel restriction,
                             RestrictionData data)
                      throws RestrictionEvaluationException

Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.

Evaluates given restriction for RestrictionData context object.

Parameters:

restriction - the restriction

data - the data

Returns:

true, if successful

Throws:

RestrictionEvaluationException - the restriction evaluation exception

evaluate

@Deprecated
boolean evaluate(CMSTimeRestrictionModel restriction)
                      throws RestrictionEvaluationException

Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.

Evaluates given restriction for RestrictionData context object.

Parameters:

restriction - the restriction

Returns:

true, if successful

Throws:

RestrictionEvaluationException - the restriction evaluation exception

evaluate

@Deprecated
boolean evaluate(CMSUserGroupRestrictionModel restriction)
                      throws RestrictionEvaluationException

Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.

Evaluates given restriction for RestrictionData context object.

Parameters:

restriction - the restriction

Returns:

true, if successful

Throws:

RestrictionEvaluationException - the restriction evaluation exception

evaluate

@Deprecated
boolean evaluate(CMSUserRestrictionModel restriction)
                      throws RestrictionEvaluationException

Deprecated. since 4.4. Method will be removed soon. Call evaluate(AbstractRestrictionModel, RestrictionData) instead.

Evaluates given restriction for RestrictionData context object.

Parameters:

restriction - the restriction

Returns:

true, if successful

Throws:

RestrictionEvaluationException - the restriction evaluation exception

evaluateCMSComponent

boolean evaluateCMSComponent(AbstractCMSComponentModel component,
                             RestrictionData data)

Evaluate cms component for RestrictionData context object.

Parameters:

component - the component

data - the data

Returns:

true, if successful

evaluateCMSComponents

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

Evaluate cms components for RestrictionData context object.

Parameters:

components - the components

data - the data

Returns:

the list

evaluatePages

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

Evaluate pages for RestrictionData context object.

Parameters:

pages - the pages

data - the data

Returns:

the collection

getCategoryCodesForRestriction

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

Gets the category codes for restriction.

Parameters:

restriction - the restriction

Returns:

the category codes for restriction

getProductCodesForRestriction

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

Gets the product codes for restriction.

Parameters:

restriction - the restriction

Returns:

the product codes for restriction