de.hybris.platform.configurablebundleservices.bundle.impl

Class DefaultBundleRuleService

java.lang.Object

de.hybris.platform.configurablebundleservices.bundle.impl.DefaultBundleRuleService

All Implemented Interfaces:

BundleRuleService

public class DefaultBundleRuleService
extends Object
implements BundleRuleService

Default implementation of the bundle rule service BundleRuleService. It uses Flexible Search queries and Java Code to find the lowest price (based on bundle price rules) for a product that is or will be part of a bundle.

Constructor Summary

Constructors

Constructor and Description
DefaultBundleRuleService()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkBundleRuleForConditionalProduct(AbstractBundleRuleModel bundleRule, Set<ProductModel> otherProductsInSameBundle, ProductModel product) Applies the check logic for disable product rules to test if the given bundleRule meets the requirements.
protected boolean	checkBundleRuleForTargetProduct(AbstractBundleRuleModel rule, Set<ProductModel> otherProductsInSameBundle) Applies the rules for conditional products to check if the given rule meets the requirements.
protected boolean	checkRuleIsFulfilled(AbstractBundleRuleModel bundleRule, ProductModel product, Set<ProductModel> otherProductsInSameBundle)
protected AbstractBundleRuleModel	evaluateBundleRules(List<AbstractBundleRuleModel> bundleRules, ProductModel product, Set<ProductModel> otherProductsInSameBundle) Evaluates if any of the given bundleRules is applicable for the given product in the context of the list of other products that are already in the same bundle.
protected BundleTemplateService	getBundleTemplateService()
protected OrderEntryDao	getCartEntryDao()
protected Set<ProductModel>	getCartProductsInSameBundle(AbstractOrderModel masterAbstractOrder, ProductModel product, int bundleNo) Returns a list of of products that belong to the same bundle in the given multi-cart as the given product
ChangeProductPriceBundleRuleModel	getChangePriceBundleRule(AbstractOrderModel masterAbstractOrder, BundleTemplateModel bundleTemplate, ProductModel targetProduct, int bundleNo) Returns a ChangeProductPriceBundleRuleModel valid for the given targetProduct.
ChangeProductPriceBundleRuleModel	getChangePriceBundleRule(BundleTemplateModel targetComponent, ProductModel targetProduct, ProductModel conditionalProduct, CurrencyModel currency) Returns a ChangeProductPriceBundleRuleModel valid for the given targetProduct.
ChangeProductPriceBundleRuleModel	getChangePriceBundleRuleForOrderEntry(AbstractOrderEntryModel entry) Returns a ChangeProductPriceBundleRuleModel valid for the given orderEntryModel.
ChangeProductPriceBundleRuleModel	getChangePriceBundleRuleWithLowestPrice(ProductModel targetProduct, CurrencyModel currency) Searches for the lowest price ChangeProductPriceBundleRuleModel of the given targetProduct in any bundle package
protected ChangeProductPriceBundleRuleDao	getChangeProductPriceBundleRuleDao()
protected BundleRuleDao	getDisableProductBundleRuleDao()
DisableProductBundleRuleModel	getDisableRuleForBundleProduct(AbstractOrderModel masterAbstractOrder, ProductModel product, BundleTemplateModel bundleTemplate, int bundleNo, boolean ignoreCurrentProducts) Returns a DisableProductBundleRuleModel valid for the given product ignoring products ignoreProducts in the cart.
DisableProductBundleRuleModel	getDisableRuleForBundleProduct(BundleTemplateModel bundleTemplate, ProductModel product1, ProductModel product2) Returns a DisableProductBundleRuleModel which does not allow that the given products product1 and product2 are added together to a bundle.
protected ChangeProductPriceBundleRuleModel	getLowestPriceForTargetProductAndTemplate(BundleTemplateModel bundleTemplate, ProductModel targetProduct, CurrencyModel currency, Set<ProductModel> otherProductsInSameBundle) Finds the ChangeProductPriceBundleRuleModel with the lowest price for the given targetProduct .
protected ModelService	getModelService()
protected SearchRestrictionService	getSearchRestrictionService()
protected SessionService	getSessionService()
void	setBundleTemplateService(BundleTemplateService bundleTemplateService)
void	setCartEntryDao(OrderEntryDao cartEntryDao)
void	setChangeProductPriceBundleRuleDao(ChangeProductPriceBundleRuleDao changeProductPriceBundleRuleDao)
void	setDisableProductBundleRuleDao(BundleRuleDao disableProductBundleRuleDao)
void	setModelService(ModelService modelService)
void	setSearchRestrictionService(SearchRestrictionService searchRestrictionService)
void	setSessionService(SessionService sessionService)
protected <A extends ItemModel,R> R	unrestricted(A model, Function<A,R> getter) Executes getter in search-restrictions-off context.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBundleRuleService

public DefaultBundleRuleService()

Method Detail

getChangePriceBundleRuleForOrderEntry

public ChangeProductPriceBundleRuleModel getChangePriceBundleRuleForOrderEntry(AbstractOrderEntryModel entry)

Description copied from interface: BundleRuleService

Returns a ChangeProductPriceBundleRuleModel valid for the given orderEntryModel. The method calculates the lowest product price for the product in the given orderEntryModel which is added to a bundle. The calculation is based on the entry's bundle template and the other products in the same bundle (conditional products)

Specified by:

getChangePriceBundleRuleForOrderEntry in interface BundleRuleService

Parameters:

entry - entry that is added to the cart as part of a bundle

Returns:

a ChangeProductPriceBundleRuleModel if existing or null

getChangePriceBundleRule

public ChangeProductPriceBundleRuleModel getChangePriceBundleRule(BundleTemplateModel targetComponent,
                                                                  ProductModel targetProduct,
                                                                  ProductModel conditionalProduct,
                                                                  CurrencyModel currency)

Description copied from interface: BundleRuleService

Returns a ChangeProductPriceBundleRuleModel valid for the given targetProduct. The method calculates (forecasts) the lowest product price for the given targetProduct which shall be added to a bundle based on the given bundle template (targetComponent) in combination with the given conditionalProduct. The bundle or a cart to which the given products should be added may or may not yet exist. The method just forecasts the possible price for the given combination of input parameters.

Specified by:

getChangePriceBundleRule in interface BundleRuleService

Parameters:

targetComponent - bundle template based on which the given targetProduct is or shall be added to a bundle

targetProduct - product that is added to a bundle and for which the product price is calculated

conditionalProduct - second product that is added to the same bundle as the given targetProduct and that is the condition for a ChangeProductPriceBundleRuleModel to be selected

currency - the currency the ChangeProductPriceBundleRuleModel must match to be selected

Returns:

a ChangeProductPriceBundleRuleModel if existing or null

getChangePriceBundleRule

public ChangeProductPriceBundleRuleModel getChangePriceBundleRule(AbstractOrderModel masterAbstractOrder,
                                                                  BundleTemplateModel bundleTemplate,
                                                                  ProductModel targetProduct,
                                                                  int bundleNo)

Description copied from interface: BundleRuleService

Returns a ChangeProductPriceBundleRuleModel valid for the given targetProduct. The method calculates (forecasts) the lowest product price for the given targetProduct which shall be added to a bundle based on the given bundle template (targetComponent). The price is retrieved from the ChangeProductPriceBundleRuleModels that can be applied based on the other products in the same bundle. The method just forecasts the possible price for the given combination of input parameters.

Specified by:

getChangePriceBundleRule in interface BundleRuleService

Parameters:

masterAbstractOrder - the master cart/order to which the given targetProduct shall be added

bundleTemplate - bundle template based on which the given targetProduct shall be added to the bundle

targetProduct - product that shall be added to the bundle and for which applicable DisableProductBundleRuleModel 's are searched

bundleNo - the number of the bundle to which the targetProduct shall be added

Returns:

ChangeProductPriceBundleRuleModel if existing or null

getChangePriceBundleRuleWithLowestPrice

public ChangeProductPriceBundleRuleModel getChangePriceBundleRuleWithLowestPrice(ProductModel targetProduct,
                                                                                 CurrencyModel currency)

Description copied from interface: BundleRuleService

Searches for the lowest price ChangeProductPriceBundleRuleModel of the given targetProduct in any bundle package

Specified by:

getChangePriceBundleRuleWithLowestPrice in interface BundleRuleService

Parameters:

targetProduct - the product for which the lowest bundle price is searched

currency - the currency the ChangeProductPriceBundleRuleModel must match to be selected

Returns:

ChangeProductPriceBundleRuleModel if existing or null

getLowestPriceForTargetProductAndTemplate

protected ChangeProductPriceBundleRuleModel getLowestPriceForTargetProductAndTemplate(BundleTemplateModel bundleTemplate,
                                                                                      ProductModel targetProduct,
                                                                                      CurrencyModel currency,
                                                                                      Set<ProductModel> otherProductsInSameBundle)

Finds the ChangeProductPriceBundleRuleModel with the lowest price for the given targetProduct . All ChangeProductPriceBundleRuleModels which are assigned to the given bundleTemplate and have the given targetProduct as target product and meet the requirements for conditional products are selected. The prices of these rules are then evaluated: The ChangeProductPriceBundleRuleModel that matches the given currency and has the lowest price, is returned.

getDisableRuleForBundleProduct

public DisableProductBundleRuleModel getDisableRuleForBundleProduct(AbstractOrderModel masterAbstractOrder,
                                                                    ProductModel product,
                                                                    BundleTemplateModel bundleTemplate,
                                                                    int bundleNo,
                                                                    boolean ignoreCurrentProducts)

Description copied from interface: BundleRuleService

Returns a DisableProductBundleRuleModel valid for the given product ignoring products ignoreProducts in the cart. The method searches for DisableProductBundleRuleModel's that can be applied if the given product is or would be added to the given masterAbstractOrder in the context of the given bundleNo and bundleTemplate.

Specified by:

getDisableRuleForBundleProduct in interface BundleRuleService

Parameters:

masterAbstractOrder - the master cart/order to which the given product is added

product - product that is or shall be added to the bundle and for which applicable DisableProductBundleRuleModel's are searched

bundleTemplate - bundle template based on which the given product is or shall be added to the bundle

bundleNo - the number of the bundle to which the product is or shall be added to a bundle

ignoreCurrentProducts - if the products in the current bundletemplate should be ignored

Returns:

the first DisableProductBundleRuleModel that is found which means that the given product cannot be added to the bundle in the cart. null if no DisableProductBundleRuleModel applies and the product can be added to the bundle.

getDisableRuleForBundleProduct

public DisableProductBundleRuleModel getDisableRuleForBundleProduct(BundleTemplateModel bundleTemplate,
                                                                    ProductModel product1,
                                                                    ProductModel product2)

Description copied from interface: BundleRuleService

Returns a DisableProductBundleRuleModel which does not allow that the given products product1 and product2 are added together to a bundle. In case no such disable rule exists null is returned.

Specified by:

getDisableRuleForBundleProduct in interface BundleRuleService

Parameters:

bundleTemplate - bundle template based on which the given targetProduct and conditionalProduct shall be added to the bundle

product1 - first product that shall be added to the bundle

product2 - second product that shall be added to the bundle

Returns:

the first DisableProductBundleRuleModel that is found which means that the given product1 and product2 cannot be added together to the bundle in the cart. null if no DisableProductBundleRuleModel applies and the products can be added to the bundle.

evaluateBundleRules

protected AbstractBundleRuleModel evaluateBundleRules(List<AbstractBundleRuleModel> bundleRules,
                                                      ProductModel product,
                                                      Set<ProductModel> otherProductsInSameBundle)

Evaluates if any of the given bundleRules is applicable for the given product in the context of the list of other products that are already in the same bundle. Depending on whether the given product is a target or a conditional product of the bundleRule the check itself is done either in method checkBundleRuleForTargetProduct or method checkBundleRuleForConditionalProduct.

getCartProductsInSameBundle

protected Set<ProductModel> getCartProductsInSameBundle(AbstractOrderModel masterAbstractOrder,
                                                        ProductModel product,
                                                        int bundleNo)

Returns a list of of products that belong to the same bundle in the given multi-cart as the given product

checkBundleRuleForTargetProduct

protected boolean checkBundleRuleForTargetProduct(AbstractBundleRuleModel rule,
                                                  Set<ProductModel> otherProductsInSameBundle)

Applies the rules for conditional products to check if the given rule meets the requirements. Returns true if the given list of products otherProductsInSameBundle matches the list of conditional products of the given rule, otherwise false.

checkBundleRuleForConditionalProduct

protected boolean checkBundleRuleForConditionalProduct(AbstractBundleRuleModel bundleRule,
                                                       Set<ProductModel> otherProductsInSameBundle,
                                                       ProductModel product)

Applies the check logic for disable product rules to test if the given bundleRule meets the requirements. Returns true if the given bundleRule is of type "ALL" and the given product is listed as a conditional product, all other conditional products and at least one of the target products are already added to the bundle in the cart. It also returns true if the given bundleRule is of type "ANY" and the given product is listed as a conditional product and at least one of the target products is already added to the bundle in the cart. In all other cases it returns false. It is assumed that the given product is in the list of conditional products of the given bundleRule.

checkRuleIsFulfilled

protected boolean checkRuleIsFulfilled(AbstractBundleRuleModel bundleRule,
                                       ProductModel product,
                                       Set<ProductModel> otherProductsInSameBundle)

unrestricted

protected <A extends ItemModel,R> R unrestricted(A model,
                                                 Function<A,R> getter)

Executes getter in search-restrictions-off context.

Type Parameters:

A - type of the object

R - type of the data

Parameters:

model - persistent object to get data from

getter - data obtaining logic

Returns:

data collected in restriction-free content

setBundleTemplateService

public void setBundleTemplateService(BundleTemplateService bundleTemplateService)

getBundleTemplateService

protected BundleTemplateService getBundleTemplateService()

setChangeProductPriceBundleRuleDao

public void setChangeProductPriceBundleRuleDao(ChangeProductPriceBundleRuleDao changeProductPriceBundleRuleDao)

getChangeProductPriceBundleRuleDao

protected ChangeProductPriceBundleRuleDao getChangeProductPriceBundleRuleDao()

setDisableProductBundleRuleDao

public void setDisableProductBundleRuleDao(BundleRuleDao disableProductBundleRuleDao)

getDisableProductBundleRuleDao

protected BundleRuleDao getDisableProductBundleRuleDao()

setCartEntryDao

public void setCartEntryDao(OrderEntryDao cartEntryDao)

getCartEntryDao

protected OrderEntryDao getCartEntryDao()

setSearchRestrictionService

public void setSearchRestrictionService(SearchRestrictionService searchRestrictionService)

getSearchRestrictionService

protected SearchRestrictionService getSearchRestrictionService()

setModelService

public void setModelService(ModelService modelService)

getModelService

protected ModelService getModelService()

setSessionService

public void setSessionService(SessionService sessionService)

getSessionService

protected SessionService getSessionService()