de.hybris.platform.subscriptionservices.subscription

Interface SubscriptionCommerceCartService

All Known Subinterfaces:

BundleCommerceCartService

All Known Implementing Classes:

DefaultBundleCommerceCartService, DefaultSubscriptionCommerceCartService

public interface SubscriptionCommerceCartService

Overrides the DefaultCommerceCartService where necessary to implement the multi-cart functionality for subscription products. The master cart which always has the billing time 'paynow' stores an entry for each product that is added to cart. Entries of subscription products that do no have a paynow price are stored with a 0.00 price in the master cart. The master cart may have one or more child carts which contain additional entries for those subscription products that have other/additional billing times. One child cart per billing time is created.

On a method level it adds or overrides existing methods in order to support SubscriptionProducts and especially their billing times. It creates or resolves the specific child cart based on the BillingFrequency and delegates the add, update (incl. remove) or calculate operation to that child cart.

Method Summary

Modifier and Type	Method and Description
CommerceCartModification	addToCart(CartModel masterCartModel, ProductModel productModel, long quantityToAdd, UnitModel unit, boolean forceNewEntry, String xmlProduct)
CommerceCartModification	addToCart(CartModel masterCartModel, ProductModel productModel, long quantityToAdd, UnitModel unit, boolean forceNewEntry, String xmlProduct, String originalSubscriptionId, AbstractOrderEntryModel originalEntry) Deprecated.
CartModel	getChildCartForBillingTime(CartModel masterCart, BillingTimeModel billFreq) Get the child cart for the given BillingTimeModel, if any.
String	getMasterCartBillingTimeCode() Get the billing frequency code for the master cart.
CartModel	getMasterCartForCartEntry(CartEntryModel cartEntryModel) Get the master cart for the given cartEntryModel.
CommerceCartModification	updateQuantityForCartEntry(CartModel cartModel, long entryNumber, long newQuantity) Update quantity for the cart entry with given entryNumber with the given newQuantity.

Method Detail

addToCart

@Deprecated
CommerceCartModification addToCart(CartModel masterCartModel,
                                               ProductModel productModel,
                                               long quantityToAdd,
                                               UnitModel unit,
                                               boolean forceNewEntry,
                                               String xmlProduct,
                                               String originalSubscriptionId,
                                               AbstractOrderEntryModel originalEntry)
                                        throws CommerceCartModificationException

Deprecated.

Throws:

CommerceCartModificationException

addToCart

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

Throws:

CommerceCartModificationException

updateQuantityForCartEntry

CommerceCartModification updateQuantityForCartEntry(CartModel cartModel,
                                                    long entryNumber,
                                                    long newQuantity)
                                             throws CommerceCartModificationException

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

Parameters:

cartModel - 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.

getMasterCartForCartEntry

CartModel getMasterCartForCartEntry(CartEntryModel cartEntryModel)

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

Parameters:

cartEntryModel - the CartEntryModel whose master CartModel is searched

Returns:

the given cartEntryModel's master CartModel

getChildCartForBillingTime

CartModel getChildCartForBillingTime(CartModel masterCart,
                                     BillingTimeModel billFreq)

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

Parameters:

masterCart - the CartModel of the master cart

billFreq - the BillingTimeModel to look for

Returns:

the CartModel for the given BillingTimeModel or null.

getMasterCartBillingTimeCode

String getMasterCartBillingTimeCode()

Get the billing frequency code for the master cart.

Returns:

a String with the billing frequency code for the master cart