de.hybris.platform.configurablebundlefacades.order

Interface BundleCartFacade

All Known Implementing Classes:

DefaultBundleCartFacade, DefaultBundleCommerceCartFacade

public interface BundleCartFacade

Bundle Cart facade interface. Service is responsible for getting and updating all necessary information for a bundle cart.

Method Summary

Modifier and Type	Method and Description
java.util.List<CartModificationData>	addToCart(java.lang.String productCode1, int bundleNo, java.lang.String bundleTemplateId1, java.lang.String productCode2, java.lang.String bundleTemplateId2) Deprecated. Since 6.4 - The products can be added in two separate calls.
CartModificationData	addToCart(java.lang.String productCode, long quantity, int groupNumber) Add a product to an existing bundle.
java.util.List<CartModificationData>	addToCart(java.lang.String productCode, long quantity, int bundleNo, java.lang.String bundleTemplateId, boolean removeCurrentProducts) Deprecated. Since 6.4 - Use startBundle(String, String, long) or addToCart(String, long, int)
void	deleteCartBundle(int bundleNo) Deprecated. Since 6.4 - use CartFacade.removeEntryGroup(Integer)
ProductSearchPageData<SearchStateData,ProductData>	getAllowedProducts(java.lang.Integer groupNumber, java.lang.String searchQuery, PageableData pageableData) Constructs pageable list of products available for entry group of type GroupType.CONFIGURABLEBUNDLE
boolean	isCartValid() Deprecated. Since 6.4
CartModificationData	startBundle(java.lang.String bundleTemplateId, java.lang.String productCode, long quantity) Start new bundle in cart based on the given bundle template and add the product to it.

Method Detail

startBundle

CartModificationData startBundle(java.lang.String bundleTemplateId,
                                 java.lang.String productCode,
                                 long quantity)
                          throws CommerceCartModificationException

Start new bundle in cart based on the given bundle template and add the product to it.

Parameters:

bundleTemplateId - a component to add the product to. He whole bundle structure - starting from the root of the component - will be added to cart groups

productCode - a product which will be added to the component

quantity - quantity for the product. Is limited by selection criteria of the component

Returns:

information about the new cart entry

Throws:

CommerceCartModificationException - if the operation is not possible

See Also:

EntryGroup, BundleSelectionCriteria

addToCart

CartModificationData addToCart(java.lang.String productCode,
                               long quantity,
                               int groupNumber)
                        throws CommerceCartModificationException

Add a product to an existing bundle.

Parameters:

productCode - product to add

quantity - quantity of the product

groupNumber - entry group number, that defines the bundle and the component within the bundle

Returns:

information about the new cart entry

Throws:

CommerceCartModificationException - if the operation is not possible

See Also:

EntryGroup

addToCart

@Deprecated
java.util.List<CartModificationData> addToCart(java.lang.String productCode,
                                                           long quantity,
                                                           int bundleNo,
                                                           java.lang.String bundleTemplateId,
                                                           boolean removeCurrentProducts)
                                                    throws CommerceCartModificationException

Deprecated. Since 6.4 - Use startBundle(String, String, long) or addToCart(String, long, int)

Adds the product with the productId and with the given quantity to the cart. If an entry with the given product exists in the cart already, then the given quantity is added to the quantity of this cart entry. 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.

Parameters:

productCode - the product id that will be added to the cart

quantity - the quantity of the product

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

bundleTemplateId - The bundletemplate id to add the product to

removeCurrentProducts - whether to remove existing products in that component

Returns:

List of CartModificationData CartModificationData

Throws:

CommerceCartModificationException

addToCart

@Deprecated
java.util.List<CartModificationData> addToCart(java.lang.String productCode1,
                                                           int bundleNo,
                                                           java.lang.String bundleTemplateId1,
                                                           java.lang.String productCode2,
                                                           java.lang.String bundleTemplateId2)
                                                    throws CommerceCartModificationException

Deprecated. Since 6.4 - The products can be added in two separate calls.

Method to add the productCode1 and productcode2 to multi-cart 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.

Parameters:

productCode1 - the first product id that will be added to the cart

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)

bundleTemplateId1 - current version of the bundleTemplate id based on which the first product is added to the cart. It will be stored on the cart entry.

productCode2 - the second product id that will be added to the cart

bundleTemplateId2 - current version of the bundleTemplate id based on which the second product is added to the cart. It will be stored on the cart entry.

Returns:

List the list of CartModificationData CartModificationData

Throws:

CommerceCartModificationException

deleteCartBundle

@Deprecated
void deleteCartBundle(int bundleNo)
                           throws CommerceCartModificationException

Deprecated. Since 6.4 - use CartFacade.removeEntryGroup(Integer)

Method to delete all cart entries of a particular bundle

Parameters:

bundleNo - bundleNo in cart

Throws:

CommerceCartModificationException

isCartValid

@Deprecated
boolean isCartValid()

Deprecated. Since 6.4

Checks if the session cart is valid (= does not contain any invalid components)

Returns:

true if the session cart is valid, otherwise false

getAllowedProducts

ProductSearchPageData<SearchStateData,ProductData> getAllowedProducts(java.lang.Integer groupNumber,
                                                                      java.lang.String searchQuery,
                                                                      PageableData pageableData)

Constructs pageable list of products available for entry group of type GroupType.CONFIGURABLEBUNDLE

Parameters:

groupNumber - entry group number related to the component

searchQuery - the search query

pageableData - the page to return

Returns:

the search results

Throws:

java.lang.IllegalArgumentException - if group is not found or group type is not GroupType.CONFIGURABLEBUNDLE