Package de.hybris.platform.configurablebundleservices.bundle.impl

Class DefaultBundleCommerceRuleService

java.lang.Object

de.hybris.platform.configurablebundleservices.bundle.impl.DefaultBundleCommerceRuleService

All Implemented Interfaces:

BundleRuleService

Direct Known Subclasses:

DefaultBundleRuleService

public class DefaultBundleCommerceRuleService
extends java.lang.Object
implements BundleRuleService

Default implementation of the bundle rule service BundleRuleService. It searches for the the lowest price (based on bundle price rules) for a product that is a part of a bundle.

Constructor Summary

Constructors

Constructor	Description
DefaultBundleCommerceRuleService()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkBundleRuleForConditionalProduct(AbstractBundleRuleModel bundleRule, java.util.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, java.util.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, java.util.Set<ProductModel> otherProductsInSameBundle)
java.lang.String	createMessageForDisableRule(DisableProductBundleRuleModel disableRule, ProductModel product)	Generates the message explaining why given product is disabled with specific rule.
protected AbstractBundleRuleModel	evaluateBundleRules(java.util.List<AbstractBundleRuleModel> bundleRules, ProductModel product, java.util.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 java.util.Set<ProductModel>	getCartProductsInSameBundle(AbstractOrderModel order, ProductModel product, EntryGroup bundleEntryGroup)	Returns a list of of products that belong to the same bundle entry group in the given multi-cart as the given product
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<AbstractBundleRuleModel>	getDisableProductBundleRuleDao()
java.util.List<DisableProductBundleRuleModel>	getDisableProductBundleRules(ProductModel product, EntryGroup entryGroup, AbstractOrderModel order)	Returns a list of DisableProductBundleRuleModel valid for the given product in the given order.
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.
DisableProductBundleRuleModel	getDisableRuleForBundleProduct(AbstractOrderModel masterAbstractOrder, ProductModel product, EntryGroup entryGroup, boolean ignoreCurrentProducts)	Returns a DisableProductBundleRuleModel valid for the given product ignoring products ignoreProducts in the cart.
protected EntryGroupService	getEntryGroupService()
protected L10NService	getL10NService()
protected ChangeProductPriceBundleRuleModel	getLowestPriceForTargetProductAndTemplate(BundleTemplateModel bundleTemplate, ProductModel targetProduct, CurrencyModel currency, java.util.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	setChangeProductPriceBundleRuleDao(ChangeProductPriceBundleRuleDao changeProductPriceBundleRuleDao)
void	setDisableProductBundleRuleDao(BundleRuleDao<AbstractBundleRuleModel> disableProductBundleRuleDao)
void	setEntryGroupService(EntryGroupService entryGroupService)
void	setL10NService(L10NService l10nService)
void	setModelService(ModelService modelService)
void	setSearchRestrictionService(SearchRestrictionService searchRestrictionService)
void	setSessionService(SessionService sessionService)
protected <A extends ItemModel,R> R	unrestricted(A model, java.util.function.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

DefaultBundleCommerceRuleService

public DefaultBundleCommerceRuleService()

Method Detail

getChangePriceBundleRuleForOrderEntry

@Nullable
public ChangeProductPriceBundleRuleModel getChangePriceBundleRuleForOrderEntry(@Nonnull
                                                                               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

getDisableProductBundleRules

public java.util.List<DisableProductBundleRuleModel> getDisableProductBundleRules(ProductModel product,
                                                                                  EntryGroup entryGroup,
                                                                                  AbstractOrderModel order)

Description copied from interface: BundleRuleService

Returns a list of DisableProductBundleRuleModel valid for the given product in the given order. The method searches for DisableProductBundleRuleModels that can be applied if the given product is or would be added to the given order in the context of the given entryGroup .

Specified by:

getDisableProductBundleRules in interface BundleRuleService

Parameters:

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

entryGroup - entry group representing a bundle to which the product is or shall be added

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

Returns:

the list of DisableProductBundleRuleModel which are blocking adding product cannot be added to the bundle in the cart.

getChangePriceBundleRule

@Nullable
public ChangeProductPriceBundleRuleModel getChangePriceBundleRule(@Nonnull
                                                                  BundleTemplateModel targetComponent,
                                                                  @Nonnull
                                                                  ProductModel targetProduct,
                                                                  @Nonnull
                                                                  ProductModel conditionalProduct,
                                                                  @Nonnull
                                                                  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

getChangePriceBundleRuleWithLowestPrice

@Nullable
public ChangeProductPriceBundleRuleModel getChangePriceBundleRuleWithLowestPrice(@Nonnull
                                                                                 ProductModel targetProduct,
                                                                                 @Nonnull
                                                                                 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

@Nullable
protected ChangeProductPriceBundleRuleModel getLowestPriceForTargetProductAndTemplate(BundleTemplateModel bundleTemplate,
                                                                                      ProductModel targetProduct,
                                                                                      CurrencyModel currency,
                                                                                      java.util.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

@Nullable
public DisableProductBundleRuleModel getDisableRuleForBundleProduct(AbstractOrderModel masterAbstractOrder,
                                                                    ProductModel product,
                                                                    EntryGroup entryGroup,
                                                                    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 entryGroup 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

entryGroup - entry group based on which the given product is or shall be added to the 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

@Nullable
public DisableProductBundleRuleModel getDisableRuleForBundleProduct(@Nonnull
                                                                    BundleTemplateModel bundleTemplate,
                                                                    @Nonnull
                                                                    ProductModel product1,
                                                                    @Nonnull
                                                                    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(java.util.List<AbstractBundleRuleModel> bundleRules,
                                                      ProductModel product,
                                                      java.util.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 java.util.Set<ProductModel> getCartProductsInSameBundle(AbstractOrderModel order,
                                                                  ProductModel product,
                                                                  EntryGroup bundleEntryGroup)

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

checkBundleRuleForTargetProduct

protected boolean checkBundleRuleForTargetProduct(AbstractBundleRuleModel rule,
                                                  java.util.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,
                                                       java.util.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,
                                       java.util.Set<ProductModel> otherProductsInSameBundle)

unrestricted

protected <A extends ItemModel,R> R unrestricted(A model,
                                                       java.util.function.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

createMessageForDisableRule

public java.lang.String createMessageForDisableRule(DisableProductBundleRuleModel disableRule,
                                                    ProductModel product)

Description copied from interface: BundleRuleService

Generates the message explaining why given product is disabled with specific rule.

Specified by:

createMessageForDisableRule in interface BundleRuleService

Parameters:

disableRule - DisableProductBundleRuleModel which disabled given product for specific conditional products

product - Disabled product

Returns:

Message about the disable rule for given product

getBundleTemplateService

protected BundleTemplateService getBundleTemplateService()

setBundleTemplateService

public void setBundleTemplateService(BundleTemplateService bundleTemplateService)

getChangeProductPriceBundleRuleDao

protected ChangeProductPriceBundleRuleDao getChangeProductPriceBundleRuleDao()

setChangeProductPriceBundleRuleDao

public void setChangeProductPriceBundleRuleDao(ChangeProductPriceBundleRuleDao changeProductPriceBundleRuleDao)

getDisableProductBundleRuleDao

protected BundleRuleDao<AbstractBundleRuleModel> getDisableProductBundleRuleDao()

setDisableProductBundleRuleDao

public void setDisableProductBundleRuleDao(BundleRuleDao<AbstractBundleRuleModel> disableProductBundleRuleDao)

getSearchRestrictionService

protected SearchRestrictionService getSearchRestrictionService()

setSearchRestrictionService

public void setSearchRestrictionService(SearchRestrictionService searchRestrictionService)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getSessionService

protected SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)

getEntryGroupService

protected EntryGroupService getEntryGroupService()

setEntryGroupService

public void setEntryGroupService(EntryGroupService entryGroupService)

getL10NService

protected L10NService getL10NService()

setL10NService

public void setL10NService(L10NService l10nService)