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 TypeMethodDescriptioncloneSavedCart(CommerceSaveCartParameter parameter) For a given save cart create a copy and store it.flagForDeletion(CommerceSaveCartParameter parameters) Method for explicitly flagging a cart for deletiongetSavedCartsCountForSiteAndUser(BaseSiteModel baseSite, UserModel user) Get the number of saved cart by user and baseSitegetSavedCartsForSiteAndUser(PageableData pageableData, BaseSiteModel baseSite, UserModel user, List<OrderStatus> orderStatus) Retrieve carts by user and baseSite where order status equals ones of the status in the list.restoreSavedCart(CommerceSaveCartParameter parameters) Method for explicitly restoring a cart using cart codesaveCart(CommerceSaveCartParameter parameters) Method for explicitly saving a cart along with additional parameters
-
Method Details
-
saveCart
CommerceSaveCartResult saveCart(CommerceSaveCartParameter parameters) throws CommerceSaveCartException Method for explicitly saving a cart along with additional parameters- Parameters:
parameters-CommerceSaveCartParameterparameter 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-CommerceSaveCartParameterparameter 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-CommerceSaveCartParameterparameter 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, List<OrderStatus> orderStatus) Retrieve carts by user and baseSite where order status equals ones of the status in the list.- Parameters:
pageableData-user- mandatory parameterbaseSite- optional parameterorderStatus- 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-CommerceSaveCartParameterparameter object that holds the cart code to be cloned- Returns:
CommerceSaveCartResult- Throws:
CommerceSaveCartException
-
getSavedCartsCountForSiteAndUser
Get the number of saved cart by user and baseSite- Parameters:
baseSite-user-- Returns:
- number of saved cart
-