de.hybris.platform.commercefacades.order

Interface SaveCartFacade

All Known Implementing Classes:

DefaultSaveCartFacade

public interface SaveCartFacade

Save Cart facade interface. Service is responsible for saved cart related functionality such as saving a cart, retrieving saved cart(s), restoring a saved cart etc.

Method Summary

Modifier and Type	Method and Description
CommerceSaveCartResultData	cloneSavedCart(CommerceSaveCartParameterData parameter) For a given save cart create a copy and store it.
CommerceSaveCartResultData	flagForDeletion(java.lang.String cartId) Method flag a saved cart for deletion
CommerceSaveCartResultData	getCartForCodeAndCurrentUser(CommerceSaveCartParameterData parameters) Get details for a specific saved cart for current user
java.lang.Integer	getSavedCartsCountForCurrentUser() Get the number of saved cart
SearchPageData<CartData>	getSavedCartsForCurrentUser(PageableData pageableData, java.util.List<OrderStatus> orderStatus) Retrieve carts where order status equals ones of the status in the list.
CartRestorationData	restoreSavedCart(CommerceSaveCartParameterData parameters) Get details for a specific saved cart for current user
CommerceSaveCartResultData	saveCart(CommerceSaveCartParameterData parameters) Method saves a cart

Method Detail

saveCart

CommerceSaveCartResultData saveCart(CommerceSaveCartParameterData parameters)
                             throws CommerceSaveCartException

Method saves a cart

Parameters:

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

Returns:

CommerceSaveCartResultData

Throws:

CommerceSaveCartException - if cart cannot be saved

flagForDeletion

CommerceSaveCartResultData flagForDeletion(java.lang.String cartId)
                                    throws CommerceSaveCartException

Method flag a saved cart for deletion

Parameters:

cartId - unique identifier of cart to be flagged

Returns:

CommerceSaveCartResultData

Throws:

CommerceSaveCartException - if cart cannot be flagged for deletion

getCartForCodeAndCurrentUser

CommerceSaveCartResultData getCartForCodeAndCurrentUser(CommerceSaveCartParameterData parameters)
                                                 throws CommerceSaveCartException

Get details for a specific saved cart for current user

Parameters:

parameters - CommerceSaveCartParameterData parameter object that holds the Id of the cart to be retrieved

Returns:

CartData

Throws:

CommerceSaveCartException - if cart can't be found/retrieved

restoreSavedCart

CartRestorationData restoreSavedCart(CommerceSaveCartParameterData parameters)
                              throws CommerceSaveCartException

Get details for a specific saved cart for current user

Parameters:

parameters - CommerceSaveCartParameterData parameter object that holds the Id of the cart to be retrieved

Returns:

CartRestorationData

Throws:

CommerceSaveCartException - if cart can't be found/retrieved

getSavedCartsForCurrentUser

SearchPageData<CartData> getSavedCartsForCurrentUser(PageableData pageableData,
                                                     java.util.List<OrderStatus> orderStatus)

Retrieve carts where order status equals ones of the status in the list.

Parameters:

pageableData -

orderStatus -

Returns:

list of saved user carts

cloneSavedCart

CommerceSaveCartResultData cloneSavedCart(CommerceSaveCartParameterData parameter)
                                   throws CommerceSaveCartException

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

Parameters:

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

Returns:

CommerceSaveCartResultData

Throws:

CommerceSaveCartException

getSavedCartsCountForCurrentUser

java.lang.Integer getSavedCartsCountForCurrentUser()

Get the number of saved cart

Returns:

the number of saved user carts