Package de.hybris.platform.commerceservices.order

Interface CommerceCartService

All Known Subinterfaces:

B2BCommerceCartService, SubscriptionCommerceCartService

All Known Implementing Classes:

DefaultB2BCommerceCartService, DefaultCommerceCartService, DefaultSubscriptionCommerceCartService

public interface CommerceCartService

Commerce service that exposes methods to deal with cart operations. This includes promotions and stock support.

Method Summary

Modifier and Type	Method	Description
CommerceCartModification	addToCart(CommerceCartParameter parameter)	Adds to the (existing) CartModel the (existing) ProductModel in the given UnitModel and with the given quantity.
CommerceCartModification	addToCart(CartModel cartModel, ProductModel productModel, long quantity, UnitModel unit, boolean forceNewEntry)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
CommerceCartModification	addToCart(CartModel cartModel, ProductModel productModel, PointOfServiceModel deliveryPointOfService, long quantity, UnitModel unit, boolean forceNewEntry)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
boolean	calculateCart(CommerceCartParameter parameter)	Calculates the given cartModel and returns true if each entry alone and after this the CartModel was calculated.
boolean	calculateCart(CartModel cartModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
void	configureCartEntry(CommerceCartParameter parameters)	Update configuration on a configurable product.
CommerceTaxEstimateResult	estimateTaxes(CommerceCartParameter parameters)	Estimate taxes for the cartModel and using the deliveryZipCode as the delivery zip code.
BigDecimal	estimateTaxes(CartModel cartModel, String deliveryZipCode, String deliveryCountryIso)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
CartModel	getCartForCodeAndUser(String code, UserModel user)	Locate a cart for the specified guid and site and user.
CartModel	getCartForGuidAndSite(String guid, BaseSiteModel site)	Locate a cart for the specified guid and site
CartModel	getCartForGuidAndSiteAndUser(String guid, BaseSiteModel site, UserModel user)	Locate a cart for the specified guid and site and user.
List<CartModel>	getCartsForSiteAndUser(BaseSiteModel site, UserModel user)	Locate all carts for the specified site and user.
void	mergeCarts(CartModel fromCart, CartModel toCart, List<CommerceCartModification> modifications)	Merge two carts and add modifications
void	recalculateCart(CommerceCartParameter parameter)	Recalculates the whole cart and all its entries.
void	recalculateCart(CartModel cartModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
void	removeAllEntries(CommerceCartParameter parameter)	Removes all entries from the given CartModel.
void	removeAllEntries(CartModel cartModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
CommerceCartModification	removeEntryGroup(RemoveEntryGroupParameter parameters)	Remove entry group and all cart entries of the group and it's descendants from the cart.
void	removeStaleCarts(CommerceCartParameter parameters)
void	removeStaleCarts(CartModel currentCart, BaseSiteModel baseSite, UserModel user)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
CommerceCartRestoration	restoreCart(CommerceCartParameter parameters)	Restores the current customer's cart.
CommerceCartRestoration	restoreCart(CartModel oldCart)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
long	split(CommerceCartParameter parameters)	Split existing cart entry.
long	split(CartModel cartModel, long entryNumber)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
void	updateCartMetadata(CommerceCartMetadataParameter parameter)	Updates cart metadata, such as: name, description, expiration time.
CommerceCartModification	updatePointOfServiceForCartEntry(CommerceCartParameter parameters)	Updates given cart entry model with point of service.
CommerceCartModification	updatePointOfServiceForCartEntry(CartModel cartModel, long entryNumber, PointOfServiceModel pointOfServiceModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
CommerceCartModification	updateQuantityForCartEntry(CommerceCartParameter parameter)	Update quantity for the cart entry with given entryNumber with the given newQuantity.
CommerceCartModification	updateQuantityForCartEntry(CartModel cartModel, long entryNumber, long newQuantity)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
CommerceCartModification	updateToShippingModeForCartEntry(CommerceCartParameter parameters)	Update the shipping mode for a given cart entry
CommerceCartModification	updateToShippingModeForCartEntry(CartModel cartModel, long entryNumber)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
List<CommerceCartModification>	validateCart(CommerceCartParameter parameter)	Method for validating every entry in the cart
List<CommerceCartModification>	validateCart(CartModel cartModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.

Method Details

addToCart

@Deprecated(since="5.2",
            forRemoval=true)
CommerceCartModification addToCart(CartModel cartModel,
 ProductModel productModel,
 long quantity,
 UnitModel unit,
 boolean forceNewEntry)
                            throws CommerceCartModificationException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use addToCart(de.hybris.platform.commerceservices.service.data.CommerceCartParameter)

Parameters:

cartModel - the user's cart in session

productModel - the ProductModel to add

quantity - 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

CommerceCartModification addToCart(CommerceCartParameter parameter)
                            throws CommerceCartModificationException

Adds to the (existing) CartModel the (existing) ProductModel in the given UnitModel and with the given quantity. If in the cart already an entry with the given product and given unit exists the given quantity is added to the the quantity of this cart entry unless forceNewEntry is set to true. After this the cart is calculated.

Parameters:

parameter - - A parameter object containing all attributes needed for add to cart

CommerceCartParameter.cart - The user's cart in session CommerceCartParameter.pointOfService - The store object for pick up in store items (only needs to be passed in if you are adding an item to pick up CommerceCartParameter.product - The ProductModel to add CommerceCartParameter.quantity - The quantity to add CommerceCartParameter.unit - The UnitModel of the product @see ProductModel.getUnit() CommerceCartParameter.createNewEntry - The flag for creating a new CartEntryModel

Returns:

the cart modification data that includes a statusCode and the actual quantity 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

@Deprecated(since="5.2",
            forRemoval=true)
CommerceCartModification addToCart(CartModel cartModel,
 ProductModel productModel,
 PointOfServiceModel deliveryPointOfService,
 long quantity,
 UnitModel unit,
 boolean forceNewEntry)
                            throws CommerceCartModificationException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use addToCart(de.hybris.platform.commerceservices.service.data.CommerceCartParameter)

Parameters:

cartModel - the user's cart in session

productModel - the ProductModel to add

deliveryPointOfService - the delivery store

quantity - 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

validateCart

List<CommerceCartModification> validateCart(CommerceCartParameter parameter)
                                     throws CommerceCartModificationException

Method for validating every entry in the cart

Parameters:

parameter -

Returns:

a list of cart modifications data that includes a statusCode and the actual quantity that the entry was updated to

Throws:

CommerceCartModificationException - if the cart could not be modified.

validateCart

@Deprecated(since="5.2",
            forRemoval=true)
List<CommerceCartModification> validateCart(CartModel cartModel)
                                     throws CommerceCartModificationException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use validateCart(de.hybris.platform.commerceservices.service.data.CommerceCartParameter)

Parameters:

cartModel - the user's cart in session

Returns:

a List of cart modifications

Throws:

CommerceCartModificationException

calculateCart

boolean calculateCart(CommerceCartParameter parameter)

Calculates the given cartModel and returns true if each entry alone and after this the CartModel was calculated. Thereby any invalid entry will be automatically removed. The net/gross prices depends on the current session user, see PriceFactory.isNetUser(de.hybris.platform.jalo.user.User) for more information.

Parameters:

parameter - the parameter object holding the existing CartModel that will be calculated

Returns:

false if the cartModel was already calculated.

calculateCart

@Deprecated(since="5.2",
            forRemoval=true)
boolean calculateCart(CartModel cartModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use calculateCart(de.hybris.platform.commerceservices.service.data.CommerceCartParameter) instead.

Parameters:

cartModel - the user's cart in session

Returns:

false if the cartModel was already calculated

recalculateCart

@Deprecated(since="5.2",
            forRemoval=true)
void recalculateCart(CartModel cartModel)
              throws CalculationException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use recalculateCart(de.hybris.platform.commerceservices.service.data.CommerceCartParameter) instead

Parameters:

cartModel - the user's cart in session

Throws:

CalculationException

recalculateCart

void recalculateCart(CommerceCartParameter parameter)
              throws CalculationException

Recalculates the whole cart and all its entries. This includes finding prices, taxes, discounts, payment and delivery costs by calling the currently installed price factory.

Parameters:

parameter - A parameter object holding the cart model CartModel (must exist) that will be recalculated CartModel

Throws:

CalculationException - the calculation exception

removeAllEntries

@Deprecated(since="5.2",
            forRemoval=true)
void removeAllEntries(CartModel cartModel)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use removeAllEntries(de.hybris.platform.commerceservices.service.data.CommerceCartParameter) instead

Parameters:

cartModel - the user's cart in session

removeAllEntries

void removeAllEntries(CommerceCartParameter parameter)

Removes all entries from the given CartModel.

Parameters:

parameter - A parameter object holding the CartModel that will be emptied

updateQuantityForCartEntry

@Deprecated(since="5.2",
            forRemoval=true)
CommerceCartModification updateQuantityForCartEntry(CartModel cartModel,
 long entryNumber,
 long newQuantity)
                                             throws CommerceCartModificationException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use updateQuantityForCartEntry(de.hybris.platform.commerceservices.service.data.CommerceCartParameter)

Parameters:

cartModel - the user's cart in session

entryNumber - the cart entry number

newQuantity - the new quantity

Returns:

the cart modification

Throws:

CommerceCartModificationException

updateQuantityForCartEntry

CommerceCartModification updateQuantityForCartEntry(CommerceCartParameter parameter)
                                             throws CommerceCartModificationException

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

Parameters:

parameter - - A parameter object containing all attributes needed for add to cart

CommerceCartParameter.cart - The user's cart in session CommerceCartParameter.pointOfService - The store object for pick up in store items (only needs to be passed in if you are adding an item to pick up CommerceCartParameter.product - The ProductModel to add CommerceCartParameter.quantity - The quantity to add CommerceCartParameter.unit - The UnitModel of the product @see ProductModel.getUnit() CommerceCartParameter.createNewEntry - The flag for creating a new CartEntryModel

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.

updatePointOfServiceForCartEntry

@Deprecated(since="5.2",
            forRemoval=true)
CommerceCartModification updatePointOfServiceForCartEntry(CartModel cartModel,
 long entryNumber,
 PointOfServiceModel pointOfServiceModel)
                                                   throws CommerceCartModificationException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use updatePointOfServiceForCartEntry(de.hybris.platform.commerceservices.service.data.CommerceCartParameter)

Parameters:

cartModel - the user's cart in session

entryNumber - the cart entry number

pointOfServiceModel - the point of service

Returns:

the cart modification

Throws:

CommerceCartModificationException

updatePointOfServiceForCartEntry

CommerceCartModification updatePointOfServiceForCartEntry(CommerceCartParameter parameters)
                                                   throws CommerceCartModificationException

Updates given cart entry model with point of service.

Parameters:

parameters - - A bean holding any number of additional parameters a client may want to pass to the method for extension purposes, the attributes can be added to the bean via beans.xml in your extensions

Returns:

CommerceCartModification object

Throws:

CommerceCartModificationException

updateToShippingModeForCartEntry

@Deprecated(since="5.2",
            forRemoval=true)
CommerceCartModification updateToShippingModeForCartEntry(CartModel cartModel,
 long entryNumber)
                                                   throws CommerceCartModificationException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use updateToShippingModeForCartEntry(de.hybris.platform.commerceservices.service.data.CommerceCartParameter)

Parameters:

cartModel - the user's cart in session

entryNumber - the cart entry number

Returns:

the cart modification

Throws:

CommerceCartModificationException

updateToShippingModeForCartEntry

CommerceCartModification updateToShippingModeForCartEntry(CommerceCartParameter parameters)
                                                   throws CommerceCartModificationException

Update the shipping mode for a given cart entry

Parameters:

parameters - - A bean holding any number of additional parameters a client may want to pass to the method for extension purposes, the attributes can be added to the bean via beans.xml in your extensions

Returns:

CommerceCartModification object

Throws:

CommerceCartModificationException

split

@Deprecated(since="5.2",
            forRemoval=true)
long split(CartModel cartModel,
 long entryNumber)
    throws CommerceCartModificationException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use split(de.hybris.platform.commerceservices.service.data.CommerceCartParameter)

Parameters:

cartModel - the user's cart in session

entryNumber - the cart entry number

Returns:

the number of the newly created entry

Throws:

CommerceCartModificationException

split

long split(CommerceCartParameter parameters)
    throws CommerceCartModificationException

Split existing cart entry. The entry must have a quantity greater than 1. One of the quantity from the original entry is moved to the new cart entry.

Parameters:

parameters - - A bean holding any number of additional parameters a client may want to pass to the method for extension purposes, the attributes can be added to the bean via beans.xml in your extensions

Returns:

The number of the newly created entry.

Throws:

CommerceCartModificationException

restoreCart

@Deprecated(since="5.2",
            forRemoval=true)
CommerceCartRestoration restoreCart(CartModel oldCart)
                             throws CommerceCartRestorationException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use restoreCart(de.hybris.platform.commerceservices.service.data.CommerceCartParameter)

Parameters:

oldCart - the old cart to restore

Returns:

details of any items that could not be restored in part or in full

Throws:

CommerceCartRestorationException

restoreCart

CommerceCartRestoration restoreCart(CommerceCartParameter parameters)
                             throws CommerceCartRestorationException

Restores the current customer's cart.

Parameters:

parameters - - A bean holding any number of additional parameters a client may want to pass to the method for extension purposes, the attributes can be added to the bean via beans.xml in your extensions

Returns:

details of any items that could not be restored in part or in full.

Throws:

CommerceCartRestorationException - if any problems occur in restoring the cart

getCartForGuidAndSiteAndUser

CartModel getCartForGuidAndSiteAndUser(String guid,
 BaseSiteModel site,
 UserModel user)

Locate a cart for the specified guid and site and user. If guid is null, the most recently modified user cart is returned.

Parameters:

guid - a unique identifier

site - the current BaseSite - may not be null

user - the current user - may not be null

Returns:

the specified cart

getCartForGuidAndSite

CartModel getCartForGuidAndSite(String guid,
 BaseSiteModel site)

Locate a cart for the specified guid and site

Parameters:

guid -

site -

Returns:

the specified cart

getCartForCodeAndUser

CartModel getCartForCodeAndUser(String code,
 UserModel user)

Locate a cart for the specified guid and site and user.

Parameters:

code -

user -

Returns:

the specified cart

getCartsForSiteAndUser

List<CartModel> getCartsForSiteAndUser(BaseSiteModel site,
 UserModel user)

Locate all carts for the specified site and user.

Parameters:

site -

user -

Returns:

list of specified carts

estimateTaxes

@Deprecated(since="5.2",
            forRemoval=true)
BigDecimal estimateTaxes(CartModel cartModel,
 String deliveryZipCode,
 String deliveryCountryIso)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use estimateTaxes(de.hybris.platform.commerceservices.service.data.CommerceCartParameter) instead.

Estimate taxes for the cartModel and using the deliveryZipCode as the delivery zip code.

Parameters:

cartModel - cart to estimate taxes for

deliveryZipCode - zip code to use as the delivery address

deliveryCountryIso - country isocode used as the delivery address

Returns:

total of the estimated taxes

estimateTaxes

CommerceTaxEstimateResult estimateTaxes(CommerceCartParameter parameters)

Estimate taxes for the cartModel and using the deliveryZipCode as the delivery zip code.

Parameters:

parameters - A parameter object holding the following properties - cartModel cart to estimate taxes for - deliveryZipCode zip code to use as the delivery address - deliveryCountryIso country iso code used as the delivery address

Returns:

A result object with the total of the estimated taxes

removeStaleCarts

@Deprecated(since="5.2",
            forRemoval=true)
void removeStaleCarts(CartModel currentCart,
 BaseSiteModel baseSite,
 UserModel user)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use removeStaleCarts(de.hybris.platform.commerceservices.service.data.CommerceCartParameter) instead.

Remove the old carts for the user.

Parameters:

currentCart - the current user's cart

baseSite - the current base site

user - the current user

removeStaleCarts

void removeStaleCarts(CommerceCartParameter parameters)

Parameters:

parameters - a parameter object holding the following values - cart Users Cart - baseSite Current base site - user Current user

mergeCarts

void mergeCarts(CartModel fromCart,
 CartModel toCart,
 List<CommerceCartModification> modifications)
         throws CommerceCartMergingException

Merge two carts and add modifications

Parameters:

fromCart - the cart to merge

toCart - the target cart

modifications - the list of modifications

Throws:

CommerceCartMergingException

configureCartEntry

void configureCartEntry(CommerceCartParameter parameters)
                 throws CommerceCartModificationException

Update configuration on a configurable product.

Parameters:

parameters -

• cart
• entryNumber
• product
• productConfigurator
• productConfiguration

Throws:

CommerceCartModificationException - if product is not configurable or entry is invalid

IllegalArgumentException - if configuration contains

updateCartMetadata

void updateCartMetadata(CommerceCartMetadataParameter parameter)

Updates cart metadata, such as: name, description, expiration time.

Parameters:

parameter - a bean holding any number of additional attributes a client may want to pass to the method for extension purposes, the attributes can be added to the bean via beans.xml in your extensions

Throws:

IllegalArgumentException - if any attributes fail validation

IllegalQuoteStateException - if the cart is associated with a quote for which the operation cannot be performed

removeEntryGroup

@Nonnull
CommerceCartModification removeEntryGroup(@Nonnull
 RemoveEntryGroupParameter parameters)
                                   throws CommerceCartModificationException

Remove entry group and all cart entries of the group and it's descendants from the cart.

Parameters:

parameters - a parameter object containing all attributes needed for remove group from the cart

• cart user's cart
• entryGroupNumber number of entry group to be removed
• enableHooks should the method hooks be executed

Returns:

CommerceCartModification object

Throws:

CommerceCartModificationException - if related cart entry wasn't removed.