de.hybris.platform.subscriptionservices.subscription.impl

Class DefaultSubscriptionCommerceCartService

java.lang.Object

de.hybris.platform.commerceservices.order.impl.DefaultCommerceCartService

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

All Implemented Interfaces:

CommerceCartService, SubscriptionCommerceCartService

Direct Known Subclasses:

DefaultBundleCommerceCartService

public class DefaultSubscriptionCommerceCartService
extends DefaultCommerceCartService
implements SubscriptionCommerceCartService

Default implementation of SubscriptionCommerceCartService.

Field Summary

Fields inherited from class de.hybris.platform.commerceservices.order.impl.DefaultCommerceCartService

ESTIMATED_TAXES

Constructor Summary

Constructors

Constructor and Description
DefaultSubscriptionCommerceCartService()

Method Summary

Modifier and Type	Method and Description
protected void	addOneRecurringFrequency(SubscriptionPricePlanModel subscriptionPricePlan, java.util.List<BillingTimeModel> billingFrequencies)
CommerceCartModification	addToCart(CartModel masterCartModel, ProductModel productModel, long quantityToAdd, UnitModel unit, boolean forceNewEntry) Deprecated. Since ages.
CommerceCartModification	addToCart(CartModel masterCartModel, ProductModel productModel, long quantityToAdd, UnitModel unit, boolean forceNewEntry, java.lang.String xmlProduct) Deprecated. Since 6.4
CommerceCartModification	addToCart(CartModel masterCartModel, ProductModel productModel, long quantityToAdd, UnitModel unit, boolean forceNewEntry, java.lang.String xmlProduct, java.lang.String originalSubscriptionId, AbstractOrderEntryModel originalEntry)
void	checkMasterCart(CartModel cartModel, BillingTimeModel masterCartBillingTimeModel) Checks if the given CartModel is a master cart and has the correct BillingTimeModel.
void	checkQuantityToAdd(long quantityToAdd) Checks if given quantity can be added.
protected void	checkQuantityToAdd(long quantityToAdd, long maxQuantity)
CartModel	createChildCartForBillingTime(CartModel masterCart, BillingTimeModel billFreq) Creates a new child cart for the given billing frequency and assigns it as child cart to the given master cart.
protected long	getAvailableStockLevel(ProductModel productModel, PointOfServiceModel pointOfServiceModel) Find the available stock quantity for a product.
protected BaseStoreService	getBaseStoreService()
java.util.List<BillingTimeModel>	getBillingFrequenciesForMasterEntry(AbstractOrderEntryModel entry)
protected BillingTimeModel	getBillingTimeForCode(java.lang.String code)
protected BillingTimeService	getBillingTimeService()
protected AbstractOrderEntryModel	getCartEntryToBeUpdated(CartModel cartModel, long entryNumber) Searches in the given cartModel for the cart entry with has the given entryNumber and returns it.
CartModel	getChildCartForBillingTime(CartModel masterCart, BillingTimeModel billFreq) Get the child cart for the given BillingTimeModel, if any.
protected SubscriptionCommercePriceService	getCommercePriceService()
protected CommerceStockService	getCommerceStockService()
java.lang.String	getMasterCartBillingTimeCode() Get the billing frequency code for the master cart.
CartModel	getMasterCartForCartEntry(CartEntryModel cartEntryModel) Get the master cart for the given cartEntryModel.
protected SubscriptionCommerceCartStrategy	getSubscriptionCommerceCartStrategy()
protected SubscriptionProductService	getSubscriptionProductService()
protected int	getSubscriptionProductStockQuantity()
protected boolean	isMasterCart(CartModel cartModel)
void	recalculateCart(CartModel masterCartModel) Overrides the super class' method to make sure that in a multi-cart system the master cart and its child carts are re-calculated.
void	recalculateCart(CommerceCartParameter parameter) Overrides the super class' method to make sure that in a multi-cart system the master cart and its child carts are re-calculated.
void	removeAllEntries(CartModel masterCartModel)
void	setBaseStoreService(BaseStoreService baseStoreService)
void	setBillingTimeService(BillingTimeService billingTimeService)
void	setCommercePriceService(SubscriptionCommercePriceService commercePriceService)
void	setCommerceStockService(CommerceStockService commerceStockService)
void	setMasterCartBillingTimeCode(java.lang.String masterCartBillingTimeCode)
void	setSubscriptionCommerceCartStrategy(SubscriptionCommerceCartStrategy subscriptionCommerceCartStrategy)
void	setSubscriptionProductService(SubscriptionProductService subscriptionProductService)
void	setSubscriptionProductStockQuantity(int subscriptionProductStockQuantity)
protected boolean	useBillingFrequencyForProduct(ProductModel subscriptionProduct, SubscriptionPricePlanModel subscriptionPricePlan)

Methods inherited from class de.hybris.platform.commerceservices.order.impl.DefaultCommerceCartService

addToCart, addToCart, afterCalculate, beforeCalculate, calculateCart, calculateCart, configureCartEntry, estimateTaxes, estimateTaxes, getBaseSiteService, getCartForCodeAndUser, getCartForGuidAndSite, getCartForGuidAndSiteAndUser, getCartsForSiteAndUser, getCartValidationStrategy, getCommerceAddToCartStrategy, getCommerceCartCalculationStrategy, getCommerceCartDao, getCommerceCartEstimateTaxesStrategy, getCommerceCartHashCalculationStrategy, getCommerceCartMergingStrategy, getCommerceCartMetadataUpdateStrategy, getCommerceCartRestorationStrategy, getCommerceCartSplitStrategy, getCommerceRemoveEntriesStrategy, getCommerceUpdateCartEntryStrategy, getModelService, getProductConfigurationStrategy, getRemoveEntryGroupStrategy, getSessionService, getStaleCartRemovalStrategy, mergeCarts, removeAllEntries, removeEntryGroup, removeStaleCarts, removeStaleCarts, restoreCart, restoreCart, setBaseSiteService, setCartValidationStrategy, setCommerceAddToCartStrategy, setCommerceCartCalculationStrategy, setCommerceCartDao, setCommerceCartEstimateTaxesStrategy, setCommerceCartHashCalculationStrategy, setCommerceCartMergingStrategy, setCommerceCartMetadataUpdateStrategy, setCommerceCartRestorationStrategy, setCommerceCartSplitStrategy, setCommerceRemoveEntriesStrategy, setCommerceUpdateCartEntryStrategy, setModelService, setProductConfigurationStrategy, setRemoveEntryGroupStrategy, setSessionService, setStaleCartRemovalStrategy, split, split, updateCartMetadata, updatePointOfServiceForCartEntry, updatePointOfServiceForCartEntry, updateQuantityForCartEntry, updateQuantityForCartEntry, updateToShippingModeForCartEntry, updateToShippingModeForCartEntry, validateCart, validateCart

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.commerceservices.order.CommerceCartService

addToCart, addToCart, calculateCart, calculateCart, configureCartEntry, estimateTaxes, estimateTaxes, getCartForCodeAndUser, getCartForGuidAndSite, getCartForGuidAndSiteAndUser, getCartsForSiteAndUser, mergeCarts, removeAllEntries, removeEntryGroup, removeStaleCarts, removeStaleCarts, restoreCart, restoreCart, split, split, updateCartMetadata, updatePointOfServiceForCartEntry, updatePointOfServiceForCartEntry, updateQuantityForCartEntry, updateQuantityForCartEntry, updateToShippingModeForCartEntry, updateToShippingModeForCartEntry, validateCart, validateCart

Constructor Detail

DefaultSubscriptionCommerceCartService

public DefaultSubscriptionCommerceCartService()

Method Detail

addToCart

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

Deprecated. Since ages.

Specified by:

addToCart in interface CommerceCartService

Overrides:

addToCart in class DefaultCommerceCartService

Parameters:

masterCartModel - the user's cart in session

productModel - the ProductModel to add

quantityToAdd - the quantity to add

unit - the UnitModel of the product @see ProductModel.getUnit()

forceNewEntry - the flag for creating a new CartEntryModel

Returns:

the cart modification

Throws:

CommerceCartModificationException

addToCart

public CommerceCartModification addToCart(CartModel masterCartModel,
                                          ProductModel productModel,
                                          long quantityToAdd,
                                          UnitModel unit,
                                          boolean forceNewEntry,
                                          java.lang.String xmlProduct,
                                          java.lang.String originalSubscriptionId,
                                          AbstractOrderEntryModel originalEntry)
                                   throws CommerceCartModificationException

Specified by:

addToCart in interface SubscriptionCommerceCartService

Parameters:

masterCartModel - master cart

productModel - the ProductModel to add

quantityToAdd - the quantity to add

unit - the UnitModel of the product

forceNewEntry - the flag for creating a new

Returns:

the cart modification

Throws:

CommerceCartModificationException

addToCart

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

Deprecated. Since 6.4

Specified by:

addToCart in interface SubscriptionCommerceCartService

Parameters:

masterCartModel - master cart

productModel - the ProductModel to add

quantityToAdd - the quantity to add

unit - the UnitModel of the product

forceNewEntry - the flag for creating a new

Returns:

the cart modification

Throws:

CommerceCartModificationException

getBillingFrequenciesForMasterEntry

public java.util.List<BillingTimeModel> getBillingFrequenciesForMasterEntry(AbstractOrderEntryModel entry)

Specified by:

getBillingFrequenciesForMasterEntry in interface SubscriptionCommerceCartService

Parameters:

entry - AbstractOrderEntryModel to get list of billing frequencies for

Returns:

List of BillingTimeModels

addOneRecurringFrequency

protected void addOneRecurringFrequency(SubscriptionPricePlanModel subscriptionPricePlan,
                                        java.util.List<BillingTimeModel> billingFrequencies)

useBillingFrequencyForProduct

protected boolean useBillingFrequencyForProduct(ProductModel subscriptionProduct,
                                                SubscriptionPricePlanModel subscriptionPricePlan)

removeAllEntries

public void removeAllEntries(CartModel masterCartModel)

Specified by:

removeAllEntries in interface CommerceCartService

Overrides:

removeAllEntries in class DefaultCommerceCartService

Parameters:

masterCartModel - the user's cart in session

getCartEntryToBeUpdated

protected AbstractOrderEntryModel getCartEntryToBeUpdated(CartModel cartModel,
                                                          long entryNumber)
                                                   throws CommerceCartModificationException

Searches in the given cartModel for the cart entry with has the given entryNumber and returns it.

Parameters:

cartModel - the cart

entryNumber - number of the cart entry

Returns:

the cart entry with the given entryNumber

Throws:

CommerceCartModificationException - if there is no cart entry with the given entryNumber

getAvailableStockLevel

protected long getAvailableStockLevel(ProductModel productModel,
                                      PointOfServiceModel pointOfServiceModel)

Find the available stock quantity for a product. Overrides the method in the super class in order to handle stock availability also for subscription products which do not have a physically available stock

Parameters:

productModel - the product in the cart

Returns:

the available stock level

getChildCartForBillingTime

public CartModel getChildCartForBillingTime(CartModel masterCart,
                                            BillingTimeModel billFreq)

Description copied from interface: SubscriptionCommerceCartService

Get the child cart for the given BillingTimeModel, if any.

Specified by:

getChildCartForBillingTime in interface SubscriptionCommerceCartService

Parameters:

masterCart - the CartModel of the master cart

billFreq - the BillingTimeModel to look for

Returns:

the CartModel for the given BillingTimeModel or null.

createChildCartForBillingTime

public CartModel createChildCartForBillingTime(CartModel masterCart,
                                               BillingTimeModel billFreq)

Creates a new child cart for the given billing frequency and assigns it as child cart to the given master cart.

Specified by:

createChildCartForBillingTime in interface SubscriptionCommerceCartService

Parameters:

masterCart - CartModel representing master cart for which child cart should be created

billFreq - BillingTimeModel for child cart

Returns:

Created child cart.

isMasterCart

protected boolean isMasterCart(CartModel cartModel)

checkMasterCart

public void checkMasterCart(CartModel cartModel,
                            BillingTimeModel masterCartBillingTimeModel)
                     throws java.lang.IllegalArgumentException,
                            CommerceCartModificationException

Checks if the given CartModel is a master cart and has the correct BillingTimeModel.

Specified by:

checkMasterCart in interface SubscriptionCommerceCartService

Parameters:

cartModel - the cart model to be checked whether it is a master cart

masterCartBillingTimeModel - the BillingTimeModel that a master cart must have. If the given cart's billing frequency is empty the masterCartBillingTimeModel will be set as billing frequency

Throws:

java.lang.IllegalArgumentException - if the given cart is not a master cart

CommerceCartModificationException - if the given cart's billing frequency does no equal the given masterCartBillingTimeModel

recalculateCart

public void recalculateCart(CartModel masterCartModel)
                     throws CalculationException

Overrides the super class' method to make sure that in a multi-cart system the master cart and its child carts are re-calculated. This includes finding prices, taxes, discounts, payment and delivery costs by calling the currently installed price factory.

Specified by:

recalculateCart in interface CommerceCartService

Overrides:

recalculateCart in class DefaultCommerceCartService

Parameters:

masterCartModel - the cart model CartModel (must exist) that will be recalculated CartModel. It must be the master cart of the multi-cart system. In addition, the master cart's child carts will also be re-calculated.

Throws:

java.lang.IllegalArgumentException - in case the given masterCartModel is not a master cart

CalculationException

recalculateCart

public void recalculateCart(CommerceCartParameter parameter)

Overrides the super class' method to make sure that in a multi-cart system the master cart and its child carts are re-calculated. This includes finding prices, taxes, discounts, payment and delivery costs by calling the currently installed price factory.

Specified by:

recalculateCart in interface CommerceCartService

Overrides:

recalculateCart in class DefaultCommerceCartService

Parameters:

parameter - checkout parameter containing the the master cart of the multi-cart

getMasterCartForCartEntry

public CartModel getMasterCartForCartEntry(CartEntryModel cartEntryModel)

Description copied from interface: SubscriptionCommerceCartService

Get the master cart for the given cartEntryModel. The cartEntryModel may be a master or child cart entry.

Specified by:

getMasterCartForCartEntry in interface SubscriptionCommerceCartService

Parameters:

cartEntryModel - the CartEntryModel whose master CartModel is searched

Returns:

the given cartEntryModel's master CartModel

checkQuantityToAdd

protected void checkQuantityToAdd(long quantityToAdd,
                                  long maxQuantity)
                           throws CommerceCartModificationException

Throws:

CommerceCartModificationException

checkQuantityToAdd

public void checkQuantityToAdd(long quantityToAdd)
                        throws CommerceCartModificationException

Description copied from interface: SubscriptionCommerceCartService

Checks if given quantity can be added.

Specified by:

checkQuantityToAdd in interface SubscriptionCommerceCartService

Throws:

CommerceCartModificationException - If given quantity is not allowed to add.

getBillingTimeForCode

protected BillingTimeModel getBillingTimeForCode(java.lang.String code)

setMasterCartBillingTimeCode

public void setMasterCartBillingTimeCode(java.lang.String masterCartBillingTimeCode)

getMasterCartBillingTimeCode

public java.lang.String getMasterCartBillingTimeCode()

Description copied from interface: SubscriptionCommerceCartService

Get the billing frequency code for the master cart.

Specified by:

getMasterCartBillingTimeCode in interface SubscriptionCommerceCartService

Returns:

a String with the billing frequency code for the master cart

setBillingTimeService

public void setBillingTimeService(BillingTimeService billingTimeService)

getBillingTimeService

protected BillingTimeService getBillingTimeService()

setSubscriptionProductStockQuantity

public void setSubscriptionProductStockQuantity(int subscriptionProductStockQuantity)

getSubscriptionProductStockQuantity

protected int getSubscriptionProductStockQuantity()

getCommercePriceService

protected SubscriptionCommercePriceService getCommercePriceService()

setCommercePriceService

public void setCommercePriceService(SubscriptionCommercePriceService commercePriceService)

getSubscriptionCommerceCartStrategy

protected SubscriptionCommerceCartStrategy getSubscriptionCommerceCartStrategy()

setSubscriptionCommerceCartStrategy

public void setSubscriptionCommerceCartStrategy(SubscriptionCommerceCartStrategy subscriptionCommerceCartStrategy)

getBaseStoreService

protected BaseStoreService getBaseStoreService()

setBaseStoreService

public void setBaseStoreService(BaseStoreService baseStoreService)

getCommerceStockService

protected CommerceStockService getCommerceStockService()

setCommerceStockService

public void setCommerceStockService(CommerceStockService commerceStockService)

getSubscriptionProductService

protected SubscriptionProductService getSubscriptionProductService()

Returns:

subscription product service

setSubscriptionProductService

public void setSubscriptionProductService(SubscriptionProductService subscriptionProductService)