de.hybris.platform.configurablebundleservices.bundle.impl

Class DefaultBundleCommerceCartService

java.lang.Object

DefaultCommerceCartService

de.hybris.platform.subscriptionservices.subscription.impl.DefaultSubscriptionCommerceCartService

de.hybris.platform.configurablebundleservices.bundle.impl.DefaultBundleCommerceCartService

All Implemented Interfaces:

BundleCommerceCartService, SubscriptionCommerceCartService

public class DefaultBundleCommerceCartService
extends DefaultSubscriptionCommerceCartService
implements BundleCommerceCartService

Default implementation of BundleCommerceCartService

Field Summary

Fields

Modifier and Type	Field and Description
static int	NEW_BUNDLE
static int	NO_BUNDLE

Constructor Summary

Constructors

Constructor and Description
DefaultBundleCommerceCartService()

Method Summary

Modifier and Type	Method and Description
protected List<CommerceCartModification>	addAutoPickProductsToCart(CartModel masterCartModel, int bundleNo, BundleTemplateModel bundleTemplate, UnitModel unit) Add auto-pick products to the bundle in the cart.
protected CommerceCartModification	addProductToCart(CartModel masterCartModel, ProductModel productModel, long quantityToAdd, UnitModel unit, boolean forceNewEntry, int bundleNo, BundleTemplateModel bundleTemplateModel, String xmlProduct, boolean ignoreEmptyBundle) Adds a product to the cart, either as standalone product or as part of a bundle.
protected void	addToBundle(AbstractOrderEntryModel entry, BundleTemplateModel bundleTemplate, int bundleNoRequested) Assign the new cart entry to an existing bundle or create a new bundle for it
CommerceCartModification	addToCart(CartModel masterCartModel, ProductModel productModel, long quantityToAdd, UnitModel unit, boolean forceNewEntry)
List<CommerceCartModification>	addToCart(CartModel masterCartModel, ProductModel productModel, long quantityToAdd, UnitModel unit, boolean forceNewEntry, int bundleNo, BundleTemplateModel bundleTemplateModel, boolean removeCurrentProducts) Deprecated.
List<CommerceCartModification>	addToCart(CartModel masterCartModel, ProductModel productModel, long quantityToAdd, UnitModel unit, boolean forceNewEntry, int bundleNo, BundleTemplateModel bundleTemplateModel, boolean removeCurrentProducts, String xmlProduct)
CommerceCartModification	addToCart(CartModel masterCartModel, ProductModel productModel, long quantityToAdd, UnitModel unit, boolean forceNewEntry, String xmlProduct)
List<CommerceCartModification>	addToCart(CartModel masterCartModel, UnitModel unit, int bundleNo, ProductModel productModel1, BundleTemplateModel bundleTemplateModel1, ProductModel productModel2, BundleTemplateModel bundleTemplateModel2) Deprecated.
List<CommerceCartModification>	addToCart(CartModel masterCartModel, UnitModel unit, int bundleNo, ProductModel productModel1, BundleTemplateModel bundleTemplateModel1, ProductModel productModel2, BundleTemplateModel bundleTemplateModel2, String xmlProduct1, String xmlProduct2) Adds the (existing) ProductModels productModel1 and productModel2 in the given UnitModel and with quantity=1 to the (existing) multi-cart CartModel as new cart entries.
boolean	calculateCart(CartModel cartModel) Overrides the super class' method to make sure that in a multi-cart system the master cart and the child carts are calculated.
String	checkAndGetReasonForDisabledProductInComponent(CartModel masterCart, ProductModel product, BundleTemplateModel bundleTemplate, int bundleNo, boolean ignoreCurrentProducts) Checks if the given product which is not yet added to the cart/bundle needs to be disabled within a component.
String	checkAndGetReasonForNotRemovableEntry(CartEntryModel cartEntry) Checks whether the given CartEntryModel could be removed from the bundle/cart (only a check, the cart is not modified!) and returns the reason if the removal is not allowed.
protected void	checkAndRemoveDependentComponents(CartModel masterCartModel, int bundleNo, BundleTemplateModel bundleTemplate) If the last item of the given bundleTemplate is deleted all items that belong to components which are dependent on the given bundleTemplate are also removed from the cart.
protected void	checkAutoPickAddToCart(BundleTemplateModel bundleTemplate, ProductModel product) Checks whether the given cartEntry is an auto-pick item and throws an CommerceCartModificationException in that case
protected void	checkAutoPickRemoval(CartEntryModel cartEntry) Checks whether the given cartEntry is an auto-pick item and throws an CommerceCartModificationException in that case
protected void	checkBundleParameters(int bundleNo, BundleTemplateModel bundleTemplateModel) Checks if given bundleNo is valid and if the combination of the given bundleNo and the given bundleTemplateModel is correct
protected void	checkCanBeAddedToComponent(CartModel masterCart, BundleTemplateModel bundleTemplate, int bundleNo)
protected void	checkIsBundleConsistent(int bundleNo, BundleTemplateModel bundleTemplateModel, CartModel masterCartModel, ProductModel productModel) Checks if the combination of the given bundleNo and bundleTemplateModel is correct in the context of the given master cart
protected void	checkIsComponentDependencyMetAfterRemoval(CartModel masterCart, BundleTemplateModel bundleTemplate, int bundleNo) Checks if an item can be removed from the given bundleTemplate (component).
boolean	checkIsComponentEditable(CartModel masterCart, BundleTemplateModel bundleTemplate, int bundleNo) Checks if the given component bundleTemplate in given bundle bundleNo and masterCart can be edited.
boolean	checkIsComponentSelectionCriteriaMet(CartModel masterCart, BundleTemplateModel bundleTemplate, int bundleNo) Checks if the selection criteria of the given component bundleTemplate in given bundle bundleNo and masterCart is met.
boolean	checkIsEntryRemovable(CartEntryModel cartEntry) Checks whether the given CartEntryModel could be removed from the bundle/cart (only a check, the cart is not modified!).
boolean	checkIsEntryUpdateable(CartEntryModel cartEntry) Checks whether the given cartEntry can be updated.
protected void	checkIsProductAlreadyInComponent(CartModel masterCart, int bundleNo, BundleTemplateModel bundleTemplate, ProductModel product) Checks whether the given product is already added to the given bundleNo and bundleTemplate.
protected void	checkIsProductDisabledByRules(CartModel masterCart, ProductModel product, BundleTemplateModel bundleTemplate, int bundleNo)
protected void	checkIsProductInComponentProductList(int bundleNo, BundleTemplateModel bundleTemplateModel, ProductModel productModel) Checks whether the given productModel is in the products list of the given bundleTemplateModel.
protected void	checkIsSelectionCriteriaNotExceeded(CartModel masterCart, BundleTemplateModel bundleTemplate, int bundleNo) Checks that not too many products are added to the given bundleNo within the given bundleTemplate (component) in the given masterCart.
protected void	checkIsSoldIndividually(ProductModel productModel, int bundleNo)
protected void	checkSelectionCriteriaNotUnderThreshold(CartEntryModel cartEntry)
protected String	createMessageForDisableRule(DisableProductBundleRuleModel disableRule, ProductModel product)
protected CommerceCartModification	createStandaloneEntry(boolean forceNewEntry, CartModel masterCartModel, ProductModel productModel, UnitModel unit, long quantityToAdd, String xmlProduct)
protected BundleTemplateModel	findAnyRequiredTemplate(CartModel masterCart, BundleTemplateModel bundleTemplate, int bundleNo)
protected OrderEntryDao	getBundleCartEntryDao()
protected AbstractBundleComponentEditableChecker<CartModel>	getBundleComponentEditableChecker()
protected BundleRuleService	getBundleRuleService()
protected BundleTemplateModel	getBundleTemplateForBundleNoFromCart(CartModel masterCartModel, int bundleNo) Find any BundleTemplate within the multi-cart for the given bundleNo.
protected BundleTemplateService	getBundleTemplateService()
List<CartEntryModel>	getCartEntriesForBundle(CartModel masterCart, int bundleNo) Gets the list of for bundleNo.
List<CartEntryModel>	getCartEntriesForComponentInBundle(CartModel masterCart, BundleTemplateModel component, int bundleNo) Gets the list of CartEntryModel for component and bundleNo.
List<CartEntryModel>	getCartEntriesForProductInBundle(CartModel masterCart, ProductModel product, int bundleNo) Gets the list of CartEntryModel for Products and bundleNo.
protected CartEntryModel	getCartEntryForUpdate(CartModel masterCartModel, ProductModel productModel, UnitModel unit) Search in the masterCart if there is already an entry whose quantity could be updated.
protected String	getDisablingReason(CartModel masterCart, ProductModel product, BundleTemplateModel bundleTemplate, int bundleNo, boolean ignoreCurrentProducts)
BundleTemplateModel	getFirstInvalidComponentInCart(CartModel masterCart) Checks the given masterCart if there are invalid components in it.
protected L10NService	getL10NService()
BillingTimeModel	getMasterBillingTime() Get the master BillingTimeModel
protected <any>	getOrderEntryModifiableChecker()
protected RemoveableChecker<CartEntryModel>	getRemovableChecker()
protected String	getSelectionCriterionMessage(CartModel masterCart, BundleTemplateModel bundleTemplate, int bundleNo)
SessionService	getSessionService()
void	removeAllEntries(CartModel masterCartModel, int bundleNo) Removes a bundle from the given CartModel and its child carts.
protected void	removeCartEntry(CartModel masterCartModel, CartEntryModel cartEntry) Removes a cart entry without performing any validation checks.
protected void	removeEntriesWithChildren(List<CartEntryModel> cartEntries, CartModel masterCartModel)
void	setBundleCartEntryDao(OrderEntryDao cartEntryDao)
void	setBundleComponentEditableChecker(AbstractBundleComponentEditableChecker<CartModel> bundleComponentEditableChecker)
void	setBundleRuleService(BundleRuleService bundleRuleService)
void	setBundleTemplateService(BundleTemplateService bundleTemplateService)
protected void	setCartEntriesInSameBundleToNotCalculated(AbstractOrderEntryModel sourceEntry) Sets all other cart entries that belong to the same bundle to "not calculated".
void	setL10NService(L10NService l10NService)
void	setOrderEntryModifiableChecker(<any> orderEntryModifiableChecker)
void	setRemovableChecker(RemoveableChecker<CartEntryModel> removableChecker)
protected void	updateLastModifiedEntriesList(CartModel masterCart, List<CommerceCartModification> modifications)
CommerceCartModification	updateQuantityForCartEntry(CartModel masterCartModel, long entryNumber, long newQuantity) Update quantity for the cart entry with given entryNumber with the given newQuantity.
CommerceCartModification	updateQuantityForCartEntry(CommerceCartParameter parameter)

Methods inherited from class de.hybris.platform.subscriptionservices.subscription.impl.DefaultSubscriptionCommerceCartService

addToCart, checkMasterCart, checkQuantityToAdd, createChildCartForBillingTime, getAvailableStockLevel, getBaseStoreService, getBillingFrequenciesForMasterEntry, getBillingTimeForCode, getBillingTimeService, getCartEntryToBeUpdated, getChildCartForBillingTime, getCommercePriceService, getCommerceStockService, getMasterCartBillingTimeCode, getMasterCartForCartEntry, getSubscriptionCommerceCartStrategy, getSubscriptionProductService, getSubscriptionProductStockQuantity, isMasterCart, recalculateCart, recalculateCart, removeAllEntries, removeEmptyChildCarts, setBaseStoreService, setBillingTimeService, setCommercePriceService, setCommerceStockService, setMasterCartBillingTimeCode, setSubscriptionCommerceCartStrategy, setSubscriptionProductService, setSubscriptionProductStockQuantity

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.subscriptionservices.subscription.SubscriptionCommerceCartService

addToCart, getChildCartForBillingTime, getMasterCartBillingTimeCode, getMasterCartForCartEntry

Field Detail

NEW_BUNDLE

public static final int NEW_BUNDLE

See Also:

Constant Field Values

NO_BUNDLE

public static final int NO_BUNDLE

See Also:

Constant Field Values

Constructor Detail

DefaultBundleCommerceCartService

public DefaultBundleCommerceCartService()

Method Detail

addToCart

@Deprecated
public List<CommerceCartModification> addToCart(CartModel masterCartModel,
                                                            ProductModel productModel,
                                                            long quantityToAdd,
                                                            UnitModel unit,
                                                            boolean forceNewEntry,
                                                            int bundleNo,
                                                            BundleTemplateModel bundleTemplateModel,
                                                            boolean removeCurrentProducts)
                                                     throws CommerceCartModificationException

Deprecated.

Description copied from interface: BundleCommerceCartService

Adds the (existing) ProductModel in the given UnitModel and with the given quantity to the (existing) CartModel. If an entry with the given product and given unit exists in the cart already, then the given quantity is added to the quantity of this cart entry unless forceNewEntry is set to true or a subscription product or a product, that is part of a bundle, is added. Dependent on the parameter bundleNo the product is added to an existing or new bundle or treated as a standalone product. In case a new bundle is created the method also adds auto-pick products to the cart if there are any setup for the bundle template. After this the multi-cart is calculated.

Specified by:

addToCart in interface BundleCommerceCartService

Parameters:

masterCartModel - the cart model. It must exist and it must be a master cart.

productModel - the product model that will be added to the cart

quantityToAdd - the quantity of the product

unit - if null ProductService#getOrderableUnit(ProductModel) is used to determine the unit

forceNewEntry - the force new entry if set to true, new cart entry will be created in any case. In case of subscription products and products that are part of a bundle there will be always a new cart entry

bundleNo - indicates to which bundle the product model shall be added (-1=create new bundle; 0=standalone product/no bundle; >0=number of existing bundle)

bundleTemplateModel - current version of the bundleTemplate model based on which the product is added to the cart. It will be stored on the cart entry. If null the product will be treated as a standalone product and the bundleNo must be 0 accordingly.

removeCurrentProducts - whether to remove current products

Returns:

the list of cart modification data CommerceCartModification that includes a statusCode and the actual quantity of the products added to the cart

Throws:

CommerceCartModificationException - if the product is a base product OR the quantity is less than 1 or no usable unit was found (only when given unit is also null) or any other reason the cart could not be modified.

addToCart

public List<CommerceCartModification> addToCart(CartModel masterCartModel,
                                                ProductModel productModel,
                                                long quantityToAdd,
                                                UnitModel unit,
                                                boolean forceNewEntry,
                                                int bundleNo,
                                                BundleTemplateModel bundleTemplateModel,
                                                boolean removeCurrentProducts,
                                                String xmlProduct)
                                         throws CommerceCartModificationException

Specified by:

addToCart in interface BundleCommerceCartService

Returns:

the list of cart modification data CommerceCartModification that includes a statusCode and the actual quantity of the products added to the cart

Throws:

CommerceCartModificationException

See Also:

BundleCommerceCartService.addToCart(CartModel, ProductModel, long, UnitModel, boolean, int, BundleTemplateModel, boolean)

addProductToCart

protected CommerceCartModification addProductToCart(CartModel masterCartModel,
                                                    ProductModel productModel,
                                                    long quantityToAdd,
                                                    UnitModel unit,
                                                    boolean forceNewEntry,
                                                    int bundleNo,
                                                    BundleTemplateModel bundleTemplateModel,
                                                    String xmlProduct,
                                                    boolean ignoreEmptyBundle)
                                             throws CommerceCartModificationException

Adds a product to the cart, either as standalone product or as part of a bundle. All relevant bundle validations are checked here. The cart is not calculated in this method, only the new entry + its cart are marked as not calculated (standalone products). In case of bundles all entries of this bundle + all affected carts are marked as not calculated. The calculation itself must be triggered by the calling method.

Throws:

CommerceCartModificationException

createStandaloneEntry

protected CommerceCartModification createStandaloneEntry(boolean forceNewEntry,
                                                         CartModel masterCartModel,
                                                         ProductModel productModel,
                                                         UnitModel unit,
                                                         long quantityToAdd,
                                                         String xmlProduct)
                                                  throws CommerceCartModificationException

Throws:

CommerceCartModificationException

addToCart

@Deprecated
public List<CommerceCartModification> addToCart(CartModel masterCartModel,
                                                            UnitModel unit,
                                                            int bundleNo,
                                                            ProductModel productModel1,
                                                            BundleTemplateModel bundleTemplateModel1,
                                                            ProductModel productModel2,
                                                            BundleTemplateModel bundleTemplateModel2)
                                                     throws CommerceCartModificationException

Deprecated.

Specified by:

addToCart in interface BundleCommerceCartService

Returns:

List of CommerceCartModifications

Throws:

CommerceCartModificationException

See Also:

BundleCommerceCartService.addToCart(CartModel, UnitModel, int, ProductModel, BundleTemplateModel, ProductModel, BundleTemplateModel, String, String)

addToCart

public List<CommerceCartModification> addToCart(CartModel masterCartModel,
                                                UnitModel unit,
                                                int bundleNo,
                                                ProductModel productModel1,
                                                BundleTemplateModel bundleTemplateModel1,
                                                ProductModel productModel2,
                                                BundleTemplateModel bundleTemplateModel2,
                                                String xmlProduct1,
                                                String xmlProduct2)
                                         throws CommerceCartModificationException

Description copied from interface: BundleCommerceCartService

Adds the (existing) ProductModels productModel1 and productModel2 in the given UnitModel and with quantity=1 to the (existing) multi-cart CartModel as new cart entries. As this method works for bundles only, both products must have a bundle template and must be part of an existing bundle or a new bundle that is created during the addToCart. In case a new bundle is created the method also adds auto-pick products to the cart if there are any setup for the bundle template. After this the multi-cart is calculated.

Specified by:

addToCart in interface BundleCommerceCartService

Parameters:

masterCartModel - the cart model. It must exist and it must be a master cart.

unit - if null ProductService#getOrderableUnit(ProductModel) is used to determine the unit

bundleNo - indicates to which bundle the product model shall be added (-1=create new bundle; >0=number of existing bundle; 0=standalone product/no bundle is not allowed here)

productModel1 - the first product model that will be added to the cart

bundleTemplateModel1 - current version of the bundleTemplate model based on which the first product is added to the cart. It will be stored on the cart entry. The parameter cannot be null.

productModel2 - the second product model that will be added to the cart

bundleTemplateModel2 - current version of the bundleTemplate model based on which the second product is added to the cart. It will be stored on the cart entry. The parameter cannot be null.

xmlProduct1 - first product in xml format

xmlProduct2 - second product in xml format

Returns:

the list of cart modification data CommerceCartModification that includes a statusCode and the actual quantity of the products added to the cart

Throws:

CommerceCartModificationException - if the product is a base product OR the quantity is less than 1 or no usable unit was found (only when given unit is also null) or the bundle parameters were empty/wrong or any other reason the cart could not be modified.

addToCart

public CommerceCartModification addToCart(CartModel masterCartModel,
                                          ProductModel productModel,
                                          long quantityToAdd,
                                          UnitModel unit,
                                          boolean forceNewEntry)
                                   throws CommerceCartModificationException

Overrides:

addToCart in class DefaultSubscriptionCommerceCartService

Throws:

CommerceCartModificationException

addToCart

public CommerceCartModification addToCart(CartModel masterCartModel,
                                          ProductModel productModel,
                                          long quantityToAdd,
                                          UnitModel unit,
                                          boolean forceNewEntry,
                                          String xmlProduct)
                                   throws CommerceCartModificationException

Specified by:

addToCart in interface SubscriptionCommerceCartService

Overrides:

addToCart in class DefaultSubscriptionCommerceCartService

Throws:

CommerceCartModificationException

updateQuantityForCartEntry

public CommerceCartModification updateQuantityForCartEntry(CommerceCartParameter parameter)
                                                    throws CommerceCartModificationException

Overrides:

updateQuantityForCartEntry in class DefaultSubscriptionCommerceCartService

Throws:

CommerceCartModificationException

updateQuantityForCartEntry

public CommerceCartModification updateQuantityForCartEntry(CartModel masterCartModel,
                                                           long entryNumber,
                                                           long newQuantity)
                                                    throws CommerceCartModificationException

Description copied from interface: SubscriptionCommerceCartService

Update quantity for the cart entry with given entryNumber with the given newQuantity. Then cart is calculated.

Specified by:

updateQuantityForCartEntry in interface SubscriptionCommerceCartService

Overrides:

updateQuantityForCartEntry in class DefaultSubscriptionCommerceCartService

Parameters:

masterCartModel - the CartModel that we will perform update on

entryNumber - the entry number that will be updated

newQuantity - the new quantity that will be set for specified cart entry

Returns:

the cart modification data that includes a statusCode and the actual quantity that the entry was updated to

Throws:

CommerceCartModificationException - if the product is a base product OR the quantity is less than 1 or no usable unit was found (only when given unit is also null) or any other reason the cart could not be modified.

addToBundle

protected void addToBundle(AbstractOrderEntryModel entry,
                           BundleTemplateModel bundleTemplate,
                           int bundleNoRequested)
                    throws CommerceCartModificationException

Assign the new cart entry to an existing bundle or create a new bundle for it

Throws:

CommerceCartModificationException

setCartEntriesInSameBundleToNotCalculated

protected void setCartEntriesInSameBundleToNotCalculated(AbstractOrderEntryModel sourceEntry)

Sets all other cart entries that belong to the same bundle to "not calculated". As the prices within a bundle may vary dependent on the bundle entries a re-calculation of the whole bundle (and all the carts that contain entries of the affected bundle) is necessary.

checkBundleParameters

protected void checkBundleParameters(int bundleNo,
                                     BundleTemplateModel bundleTemplateModel)
                              throws CommerceCartModificationException

Checks if given bundleNo is valid and if the combination of the given bundleNo and the given bundleTemplateModel is correct

Throws:

CommerceCartModificationException

checkIsBundleConsistent

protected void checkIsBundleConsistent(int bundleNo,
                                       BundleTemplateModel bundleTemplateModel,
                                       CartModel masterCartModel,
                                       ProductModel productModel)
                                throws CommerceCartModificationException

Checks if the combination of the given bundleNo and bundleTemplateModel is correct in the context of the given master cart

Throws:

CommerceCartModificationException

checkIsProductInComponentProductList

protected void checkIsProductInComponentProductList(int bundleNo,
                                                    BundleTemplateModel bundleTemplateModel,
                                                    ProductModel productModel)
                                             throws CommerceCartModificationException

Checks whether the given productModel is in the products list of the given bundleTemplateModel. This is only checked for products to be added to a bundle

Throws:

CommerceCartModificationException

checkIsProductAlreadyInComponent

protected void checkIsProductAlreadyInComponent(CartModel masterCart,
                                                int bundleNo,
                                                BundleTemplateModel bundleTemplate,
                                                ProductModel product)
                                         throws CommerceCartModificationException

Checks whether the given product is already added to the given bundleNo and bundleTemplate. As it is not allowed to add the same product more than once to the same component an CommerceCartModificationException is thrown in case the product is already in the component.

Throws:

CommerceCartModificationException

checkIsSelectionCriteriaNotExceeded

protected void checkIsSelectionCriteriaNotExceeded(CartModel masterCart,
                                                   BundleTemplateModel bundleTemplate,
                                                   int bundleNo)
                                            throws CommerceCartModificationException

Checks that not too many products are added to the given bundleNo within the given bundleTemplate (component) in the given masterCart. The check is based on the selectionCriteria of the given bundleTemplate which limit the max. possible product selections.

Throws:

CommerceCartModificationException

checkIsEntryRemovable

public boolean checkIsEntryRemovable(CartEntryModel cartEntry)

Description copied from interface: BundleCommerceCartService

Checks whether the given CartEntryModel could be removed from the bundle/cart (only a check, the cart is not modified!). The check is based on the selectionCritera of the given cartEntry's component (bundle template). If with the removal of the given cartEntry the lower limit of required product selections would not be met any more, the check returns false, otherwise true.

Specified by:

checkIsEntryRemovable in interface BundleCommerceCartService

Parameters:

cartEntry - cart entry that is checked whether it can be removed from the cart/bundle

Returns:

true if the given cartEntry can be removed from the cart, otherwise false

checkAndGetReasonForNotRemovableEntry

public String checkAndGetReasonForNotRemovableEntry(CartEntryModel cartEntry)

Description copied from interface: BundleCommerceCartService

Checks whether the given CartEntryModel could be removed from the bundle/cart (only a check, the cart is not modified!) and returns the reason if the removal is not allowed. The check is based on the selectionCritera of the given cartEntry's component (bundle template). If with the removal of the given cartEntry the lower limit of required product selections would not be met any more, the check returns the reason as String, otherwise null.

Specified by:

checkAndGetReasonForNotRemovableEntry in interface BundleCommerceCartService

Parameters:

cartEntry - cart entry that is checked whether it can be removed from the cart/bundle

Returns:

the reason as String why the given cartEntry cannot be removed, otherwise null

checkSelectionCriteriaNotUnderThreshold

protected void checkSelectionCriteriaNotUnderThreshold(CartEntryModel cartEntry)
                                                throws CommerceCartModificationException

Throws:

CommerceCartModificationException

checkAutoPickRemoval

protected void checkAutoPickRemoval(CartEntryModel cartEntry)
                             throws CommerceCartModificationException

Checks whether the given cartEntry is an auto-pick item and throws an CommerceCartModificationException in that case

Throws:

CommerceCartModificationException

checkAutoPickAddToCart

protected void checkAutoPickAddToCart(BundleTemplateModel bundleTemplate,
                                      ProductModel product)
                               throws CommerceCartModificationException

Checks whether the given cartEntry is an auto-pick item and throws an CommerceCartModificationException in that case

Throws:

CommerceCartModificationException

addAutoPickProductsToCart

protected List<CommerceCartModification> addAutoPickProductsToCart(CartModel masterCartModel,
                                                                   int bundleNo,
                                                                   BundleTemplateModel bundleTemplate,
                                                                   UnitModel unit)
                                                            throws CommerceCartModificationException

Add auto-pick products to the bundle in the cart. The root bundle template's components (= child templates) are investigated if their selection criteria type is auto-pick. If so, the component's products are automatically added to the bundle. The cart is not calculated here. Assumption is that there are no dependencies of the auto-pick components to each other or to other components in the bundle.

Throws:

CommerceCartModificationException

getBundleTemplateForBundleNoFromCart

protected BundleTemplateModel getBundleTemplateForBundleNoFromCart(CartModel masterCartModel,
                                                                   int bundleNo)

Find any BundleTemplate within the multi-cart for the given bundleNo. As there may be several different BundleTemplates for the bundleNo the first template that is found will be returned.

removeAllEntries

public void removeAllEntries(CartModel masterCartModel,
                             int bundleNo)
                      throws CommerceCartModificationException

Description copied from interface: BundleCommerceCartService

Removes a bundle from the given CartModel and its child carts. The given CartModel must be a master cart. All entries within the multi-cart (master + child carts) that belong to the same bundle identified by the given bundleNo are removed from the multi cart.

Specified by:

removeAllEntries in interface BundleCommerceCartService

Parameters:

masterCartModel - the CartModel. It must exist and it must be a master cart.

bundleNo - the number of the bundle

Throws:

CommerceCartModificationException - if the given CartModel is not a master cart

checkAndRemoveDependentComponents

protected void checkAndRemoveDependentComponents(CartModel masterCartModel,
                                                 int bundleNo,
                                                 BundleTemplateModel bundleTemplate)

If the last item of the given bundleTemplate is deleted all items that belong to components which are dependent on the given bundleTemplate are also removed from the cart. Only components that have a direct dependency on the given bundleTemplate are deleted. Components that have an indirect dependency (via a 3rd component) are not removed (this method has to be overridden to implement this feature).

removeEntriesWithChildren

protected void removeEntriesWithChildren(List<CartEntryModel> cartEntries,
                                         CartModel masterCartModel)

removeCartEntry

protected void removeCartEntry(CartModel masterCartModel,
                               CartEntryModel cartEntry)

Removes a cart entry without performing any validation checks. The cart from which the entry is removed is not recalculated but flagged as not-calculated. In case the last entry of a child cart is removed the empty child cart is also deleted.

checkIsSoldIndividually

protected void checkIsSoldIndividually(ProductModel productModel,
                                       int bundleNo)
                                throws CommerceCartModificationException

Throws:

CommerceCartModificationException

getCartEntryForUpdate

protected CartEntryModel getCartEntryForUpdate(CartModel masterCartModel,
                                               ProductModel productModel,
                                               UnitModel unit)

Search in the masterCart if there is already an entry whose quantity could be updated. This cart entry must match the given product and unit. It must not be a give-away product, nor a subscription product, nor part of a bundle, nor an entry selected for picking up in store.

calculateCart

public boolean calculateCart(CartModel cartModel)

Overrides the super class' method to make sure that in a multi-cart system the master cart and the child carts are calculated. The calculation is not triggered if the session attribute CALCULATE_CART exists and is set to Boolean.False

checkIsEntryUpdateable

public boolean checkIsEntryUpdateable(CartEntryModel cartEntry)

Description copied from interface: BundleCommerceCartService

Checks whether the given cartEntry can be updated. Any cart entry CartEntryModel belonging to a bundle BundleTemplateModel cannot be updated.

Specified by:

checkIsEntryUpdateable in interface BundleCommerceCartService

Parameters:

cartEntry - cart Entry that is checked

Returns:

true if given cartEntry can be update, otherwise false

checkIsComponentEditable

public boolean checkIsComponentEditable(CartModel masterCart,
                                        BundleTemplateModel bundleTemplate,
                                        int bundleNo)

Description copied from interface: BundleCommerceCartService

Checks if the given component bundleTemplate in given bundle bundleNo and masterCart can be edited. The check is based on the selection dependencies of the given bundleTemplate. In case the given bundleTemplate's selection criteria is of type AutoPickBundleSelectionCriteriaModel, it is never editable.

Specified by:

checkIsComponentEditable in interface BundleCommerceCartService

Parameters:

masterCart - the master cart the bundle is in

bundleTemplate - the component that is checked whether it can be edited

bundleNo - the number of the bundle the given bundleTemplate belongs to

Returns:

true if the selection dependencies are fulfilled and the component can be edited, otherwise false

checkIsComponentSelectionCriteriaMet

public boolean checkIsComponentSelectionCriteriaMet(CartModel masterCart,
                                                    BundleTemplateModel bundleTemplate,
                                                    int bundleNo)

Description copied from interface: BundleCommerceCartService

Checks if the selection criteria of the given component bundleTemplate in given bundle bundleNo and masterCart is met.

Specified by:

checkIsComponentSelectionCriteriaMet in interface BundleCommerceCartService

Parameters:

masterCart - the master cart the bundle is in

bundleTemplate - the component that is checked whether its selection criteria is met

bundleNo - the number of the bundle the given bundleTemplate belongs to

Returns:

true if given bundleTemplate's's selection criteria is met, otherwise false

checkCanBeAddedToComponent

protected void checkCanBeAddedToComponent(CartModel masterCart,
                                          BundleTemplateModel bundleTemplate,
                                          int bundleNo)
                                   throws CommerceCartModificationException

Throws:

CommerceCartModificationException

checkIsComponentDependencyMetAfterRemoval

protected void checkIsComponentDependencyMetAfterRemoval(CartModel masterCart,
                                                         BundleTemplateModel bundleTemplate,
                                                         int bundleNo)
                                                  throws CommerceCartModificationException

Checks if an item can be removed from the given bundleTemplate (component). If the given bundleTemplate becomes invalid or would be removed completely (if last item is deleted), other components in the same bundle would also become invalid if they have a dependency on the given component. In that case an exception is thrown

Throws:

CommerceCartModificationException

findAnyRequiredTemplate

protected BundleTemplateModel findAnyRequiredTemplate(CartModel masterCart,
                                                      BundleTemplateModel bundleTemplate,
                                                      int bundleNo)

checkIsProductDisabledByRules

protected void checkIsProductDisabledByRules(CartModel masterCart,
                                             ProductModel product,
                                             BundleTemplateModel bundleTemplate,
                                             int bundleNo)
                                      throws CommerceCartModificationException

Throws:

CommerceCartModificationException

checkAndGetReasonForDisabledProductInComponent

public String checkAndGetReasonForDisabledProductInComponent(CartModel masterCart,
                                                             ProductModel product,
                                                             BundleTemplateModel bundleTemplate,
                                                             int bundleNo,
                                                             boolean ignoreCurrentProducts)

Description copied from interface: BundleCommerceCartService

Checks if the given product which is not yet added to the cart/bundle needs to be disabled within a component. A product needs to be disabled if a disable rule is applicable (see description of method isProductDisabledInBundle() above) and/or the selection criteria of the component is exceeded. If the given product needs to be disabled the reason is returned as String. If ignoreCurrentProducts is enabled, then all product of the current component will be ignored when finding disable rules.

Specified by:

checkAndGetReasonForDisabledProductInComponent in interface BundleCommerceCartService

Parameters:

masterCart - the master cart the bundle is in

product - the product which is to be added to the given bundleNo

bundleTemplate - the component to which the given product is linked

bundleNo - the number of the bundle the given bundleTemplate and product belong to or will be added

ignoreCurrentProducts - if current products should be ignored

Returns:

the reason as String why the given product needs to be disabled, otherwise null

getSelectionCriterionMessage

protected String getSelectionCriterionMessage(CartModel masterCart,
                                              BundleTemplateModel bundleTemplate,
                                              int bundleNo)

getDisablingReason

protected String getDisablingReason(CartModel masterCart,
                                    ProductModel product,
                                    BundleTemplateModel bundleTemplate,
                                    int bundleNo,
                                    boolean ignoreCurrentProducts)

createMessageForDisableRule

protected String createMessageForDisableRule(DisableProductBundleRuleModel disableRule,
                                             ProductModel product)

getCartEntriesForProductInBundle

public List<CartEntryModel> getCartEntriesForProductInBundle(CartModel masterCart,
                                                             ProductModel product,
                                                             int bundleNo)

Description copied from interface: BundleCommerceCartService

Gets the list of CartEntryModel for Products and bundleNo.

Specified by:

getCartEntriesForProductInBundle in interface BundleCommerceCartService

Parameters:

masterCart - the master cart the bundle is in

product - the product for which the cartentries should be found

bundleNo - the bundleNo for which the cartentries should be found

Returns:

List

getCartEntriesForComponentInBundle

public List<CartEntryModel> getCartEntriesForComponentInBundle(CartModel masterCart,
                                                               BundleTemplateModel component,
                                                               int bundleNo)

Description copied from interface: BundleCommerceCartService

Gets the list of CartEntryModel for component and bundleNo.

Specified by:

getCartEntriesForComponentInBundle in interface BundleCommerceCartService

Parameters:

masterCart - the master cart the bundle is in

component - the component for which the cartentries should be found

bundleNo - the bundleNo for which the cartentries should be found

Returns:

List

getCartEntriesForBundle

public List<CartEntryModel> getCartEntriesForBundle(CartModel masterCart,
                                                    int bundleNo)

Description copied from interface: BundleCommerceCartService

Gets the list of for bundleNo.

Specified by:

getCartEntriesForBundle in interface BundleCommerceCartService

Parameters:

masterCart - the master cart the bundle is in

bundleNo - the bundleNo for which the cartEntries should be found

Returns:

list of CartEntryModel with specific bundle number

getFirstInvalidComponentInCart

public BundleTemplateModel getFirstInvalidComponentInCart(CartModel masterCart)

Description copied from interface: BundleCommerceCartService

Checks the given masterCart if there are invalid components in it.

Specified by:

getFirstInvalidComponentInCart in interface BundleCommerceCartService

Returns:

the first invalid component BundleTemplateModel if there is one, otherwise null

updateLastModifiedEntriesList

protected void updateLastModifiedEntriesList(CartModel masterCart,
                                             List<CommerceCartModification> modifications)

setBundleTemplateService

public void setBundleTemplateService(BundleTemplateService bundleTemplateService)

getBundleTemplateService

protected BundleTemplateService getBundleTemplateService()

setBundleCartEntryDao

public void setBundleCartEntryDao(OrderEntryDao cartEntryDao)

getBundleCartEntryDao

protected OrderEntryDao getBundleCartEntryDao()

getRemovableChecker

protected RemoveableChecker<CartEntryModel> getRemovableChecker()

setRemovableChecker

public void setRemovableChecker(RemoveableChecker<CartEntryModel> removableChecker)

setOrderEntryModifiableChecker

public void setOrderEntryModifiableChecker(<any> orderEntryModifiableChecker)

getOrderEntryModifiableChecker

protected <any> getOrderEntryModifiableChecker()

setBundleComponentEditableChecker

public void setBundleComponentEditableChecker(AbstractBundleComponentEditableChecker<CartModel> bundleComponentEditableChecker)

getBundleComponentEditableChecker

protected AbstractBundleComponentEditableChecker<CartModel> getBundleComponentEditableChecker()

setBundleRuleService

public void setBundleRuleService(BundleRuleService bundleRuleService)

getBundleRuleService

protected BundleRuleService getBundleRuleService()

getMasterBillingTime

public BillingTimeModel getMasterBillingTime()

Description copied from interface: BundleCommerceCartService

Get the master BillingTimeModel

Specified by:

getMasterBillingTime in interface BundleCommerceCartService

Returns:

BillingTimeModel

setL10NService

public void setL10NService(L10NService l10NService)

getL10NService

protected L10NService getL10NService()

getSessionService

public SessionService getSessionService()