com.broadleafcommerce.cartoperation.service

Interface ItemListItemManagementService<I extends com.broadleafcommerce.cart.client.domain.ItemListItem>

All Known Implementing Classes:

DefaultItemListItemManagementService

public interface ItemListItemManagementService<I extends com.broadleafcommerce.cart.client.domain.ItemListItem>

Service responsible for managing actions to item list items.

Author:

Jacob Mitash

Method Summary

Modifier and Type	Method and Description
List<I>	createItemListItems(String listId, Collection<I> createRequests, com.broadleafcommerce.cart.client.domain.CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) Creates item list items.
void	deleteItemListItems(String listId, Collection<String> itemIds, com.broadleafcommerce.cart.client.domain.CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) Deletes item list items from a list.
org.springframework.data.domain.Page<I>	getItemListItemPage(String listId, com.broadleafcommerce.cart.client.domain.CustomerRef customerRef, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) Gets a page of item list items.
List<I>	getItemListItems(String listId, Collection<String> itemIds, com.broadleafcommerce.cart.client.domain.CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) Gets specific item list items by their IDs.
List<I>	replaceItemListItems(String listId, Collection<I> updateRequests, com.broadleafcommerce.cart.client.domain.CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) Replaces item list items.
List<I>	updateItemListItems(String listId, Collection<I> updateRequests, com.broadleafcommerce.cart.client.domain.CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) Updates item list items.

Method Detail

getItemListItemPage

org.springframework.data.domain.Page<I> getItemListItemPage(String listId,
                                                            com.broadleafcommerce.cart.client.domain.CustomerRef customerRef,
                                                            @Nullable
                                                            org.springframework.data.domain.Pageable pageable,
                                                            @Nullable
                                                            com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Gets a page of item list items.

Parameters:

listId - the ID of the item list to fetch items from

customerRef - Information about the owning customer

pageable - the page information

context - the context of the request

Returns:

a page of items

getItemListItems

List<I> getItemListItems(String listId,
                         Collection<String> itemIds,
                         com.broadleafcommerce.cart.client.domain.CustomerRef customerRef,
                         @Nullable
                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Gets specific item list items by their IDs.

Parameters:

listId - the ID of the item list to fetch items from

itemIds - the IDs of the items to find

customerRef - Information about the owning customer

context - the context of the request

Returns:

a list of items

createItemListItems

List<I> createItemListItems(String listId,
                            Collection<I> createRequests,
                            com.broadleafcommerce.cart.client.domain.CustomerRef customerRef,
                            @Nullable
                            com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Creates item list items.

Parameters:

listId - the ID of the item list to create the items for

createRequests - the item creation requests

customerRef - Information about the owning customer

context - the context of the request

Returns:

a list of create item list items

replaceItemListItems

List<I> replaceItemListItems(String listId,
                             Collection<I> updateRequests,
                             com.broadleafcommerce.cart.client.domain.CustomerRef customerRef,
                             @Nullable
                             com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Replaces item list items.

Parameters:

listId - the ID of the item list to replace items in

updateRequests - the item update requests

customerRef - Information about the owning customer

context - the context of the request

Returns:

a list of replaced items

updateItemListItems

List<I> updateItemListItems(String listId,
                            Collection<I> updateRequests,
                            com.broadleafcommerce.cart.client.domain.CustomerRef customerRef,
                            @Nullable
                            com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Updates item list items.

Parameters:

listId - the ID of the item list to update items in

updateRequests - the item update requests

context - the context of the request

Returns:

a list of updated items

deleteItemListItems

void deleteItemListItems(String listId,
                         Collection<String> itemIds,
                         com.broadleafcommerce.cart.client.domain.CustomerRef customerRef,
                         @Nullable
                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Deletes item list items from a list.

Parameters:

listId - the ID of the list to delete from

itemIds - the IDs of the items to delete

customerRef - Information about the owning customer

context - the context of the request