de.hybris.platform.commerceservices.order

Interface CommerceSaveCartService

All Known Implementing Classes:

DefaultCommerceSaveCartService

public interface CommerceSaveCartService

Commerce service that extends the interface CommerceCartService to expose methods to deal with operations for saved carts (saving, retrieving, restoring, etc).

Method Summary

Modifier and Type	Method and Description
CommerceSaveCartResult	cloneSavedCart(CommerceSaveCartParameter parameter) For a given save cart create a copy and store it.
CommerceSaveCartResult	flagForDeletion(CommerceSaveCartParameter parameters) Method for explicitly flagging a cart for deletion
java.lang.Integer	getSavedCartsCountForSiteAndUser(BaseSiteModel baseSite, UserModel user) Get the number of saved cart by user and baseSite
SearchPageData<CartModel>	getSavedCartsForSiteAndUser(PageableData pageableData, BaseSiteModel baseSite, UserModel user, java.util.List<OrderStatus> orderStatus) Retrieve carts by user and baseSite where order status equals ones of the status in the list.
CommerceCartRestoration	restoreSavedCart(CommerceSaveCartParameter parameters) Method for explicitly restoring a cart using cart code
CommerceSaveCartResult	saveCart(CommerceSaveCartParameter parameters) Method for explicitly saving a cart along with additional parameters

Method Detail

saveCart

CommerceSaveCartResult saveCart(CommerceSaveCartParameter parameters)
                         throws CommerceSaveCartException

Method for explicitly saving a cart along with additional parameters

Parameters:

parameters - CommerceSaveCartParameter parameter object that holds the cart to be saved along with some additional details such as a name and a description for this cart

Returns:

CommerceSaveCartResult

Throws:

CommerceSaveCartException - if cart cannot be saved

flagForDeletion

CommerceSaveCartResult flagForDeletion(CommerceSaveCartParameter parameters)
                                throws CommerceSaveCartException

Method for explicitly flagging a cart for deletion

Parameters:

parameters - CommerceSaveCartParameter parameter object that holds the cart to be flagged for deletion

Returns:

CommerceSaveCartResult

Throws:

CommerceSaveCartException - if cart cannot be flagged for deletion

restoreSavedCart

CommerceCartRestoration restoreSavedCart(CommerceSaveCartParameter parameters)
                                  throws CommerceSaveCartException

Method for explicitly restoring a cart using cart code

Parameters:

parameters - CommerceSaveCartParameter parameter object that holds the cart code to be restored

Returns:

CommerceCartRestoration

Throws:

CommerceSaveCartException - if cart cannot be restored

getSavedCartsForSiteAndUser

SearchPageData<CartModel> getSavedCartsForSiteAndUser(PageableData pageableData,
                                                      BaseSiteModel baseSite,
                                                      UserModel user,
                                                      java.util.List<OrderStatus> orderStatus)

Retrieve carts by user and baseSite where order status equals ones of the status in the list.

Parameters:

pageableData -

user - mandatory parameter

baseSite - optional parameter

orderStatus - optional list

Returns:

list of saved user carts

cloneSavedCart

CommerceSaveCartResult cloneSavedCart(CommerceSaveCartParameter parameter)
                               throws CommerceSaveCartException

For a given save cart create a copy and store it.

Parameters:

parameter - CommerceSaveCartParameter parameter object that holds the cart code to be cloned

Returns:

CommerceSaveCartResult

Throws:

CommerceSaveCartException

getSavedCartsCountForSiteAndUser

java.lang.Integer getSavedCartsCountForSiteAndUser(BaseSiteModel baseSite,
                                                   UserModel user)

Get the number of saved cart by user and baseSite

Parameters:

baseSite -

user -

Returns:

number of saved cart