LegacyOrderService (BroadleafCommerce Framework 5.2.20-GA API)

All Superinterfaces:

OrderService

All Known Subinterfaces:

LegacyCartService

All Known Implementing Classes:

LegacyCartServiceImpl, LegacyOrderServiceImpl

Deprecated.
```
@Deprecated
public interface LegacyOrderService
extends OrderService
```
This legacy interface should no longer be used as of 2.0 The new interface and implementation are OrderService and OrderServiceImpl

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`OrderItem`	`addBundleItemToOrder(Order order, BundleOrderItemRequest itemRequest)` Deprecated. Used to create dynamic bundles groupings of order items.
`OrderItem`	`addBundleItemToOrder(Order order, BundleOrderItemRequest itemRequest, boolean priceOrder)` Deprecated. Used to create dynamic bundles groupings of order items.
`OrderItem`	`addDiscreteItemToOrder(Order order, DiscreteOrderItemRequest itemRequest)` Deprecated. Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
`OrderItem`	`addDiscreteItemToOrder(Order order, DiscreteOrderItemRequest itemRequest, boolean priceOrder)` Deprecated. Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder) Due to cart merging and gathering requirements, the item returned is not an actual cart item. NOTE: this will automatically associate the given order to the given itemRequest such that the resulting `OrderItem` will already have the `Order` associated to it
`OrderItem`	`addDynamicPriceDiscreteItemToOrder(Order order, DiscreteOrderItemRequest itemRequest, HashMap skuPricingConsiderations)` Deprecated. Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
`OrderItem`	`addDynamicPriceDiscreteItemToOrder(Order order, DiscreteOrderItemRequest itemRequest, HashMap skuPricingConsiderations, boolean priceOrder)` Deprecated. Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
`FulfillmentGroup`	`addFulfillmentGroupToOrder(FulfillmentGroupRequest fulfillmentGroupRequest)` Deprecated.
`FulfillmentGroup`	`addFulfillmentGroupToOrder(FulfillmentGroupRequest fulfillmentGroupRequest, boolean priceOrder)` Deprecated.
`FulfillmentGroup`	`addFulfillmentGroupToOrder(Order order, FulfillmentGroup fulfillmentGroup)` Deprecated.
`FulfillmentGroup`	`addFulfillmentGroupToOrder(Order order, FulfillmentGroup fulfillmentGroup, boolean priceOrder)` Deprecated.
`OrderItem`	`addGiftWrapItemToOrder(Order order, GiftWrapOrderItemRequest itemRequest)` Deprecated. Note: This method will automatically associate the given order to the given itemRequest such that then resulting `OrderItem` will already have an `Order` associated to it.
`FulfillmentGroup`	`addItemToFulfillmentGroup(OrderItem item, FulfillmentGroup fulfillmentGroup)` Deprecated.
`FulfillmentGroup`	`addItemToFulfillmentGroup(OrderItem item, FulfillmentGroup fulfillmentGroup, boolean priceOrder)` Deprecated.
`FulfillmentGroup`	`addItemToFulfillmentGroup(OrderItem item, FulfillmentGroup fulfillmentGroup, int quantity)` Deprecated.
`FulfillmentGroup`	`addItemToFulfillmentGroup(OrderItem item, FulfillmentGroup fulfillmentGroup, int quantity, boolean priceOrder)` Deprecated.
`FulfillmentGroup`	`addItemToFulfillmentGroup(Order order, OrderItem item, FulfillmentGroup fulfillmentGroup, int quantity, boolean priceOrder)` Deprecated.
`Order`	`addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)` Deprecated. Adds an item to the passed in order.
`OrderItem`	`addOrderItemToBundle(Order order, BundleOrderItem bundle, DiscreteOrderItem newOrderItem, boolean priceOrder)` Deprecated.
`OrderItem`	`addOrderItemToOrder(Order order, OrderItem newOrderItem)` Deprecated. Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
`OrderItem`	`addOrderItemToOrder(Order order, OrderItem newOrderItem, boolean priceOrder)` Deprecated. Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
`Order`	`addOrUpdateOrderItemAttributes(Order order, OrderItem item, Map<String,String> attributeValues, boolean priceOrder)` Deprecated. Adds the passed in name/value pair to the order-item.
`OrderPayment`	`addPaymentToOrder(Order order, OrderPayment payment)` Deprecated.
`OrderItem`	`addSkuToOrder(Long orderId, Long skuId, Long productId, Long categoryId, Integer quantity)` Deprecated. Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
`OrderItem`	`addSkuToOrder(Long orderId, Long skuId, Long productId, Long categoryId, Integer quantity, boolean priceOrder)` Deprecated. Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
`OrderItem`	`addSkuToOrder(Long orderId, Long skuId, Long productId, Long categoryId, Integer quantity, boolean priceOrder, Map<String,String> orderItemAttributes)` Deprecated. Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
`OrderItem`	`addSkuToOrder(Long orderId, Long skuId, Long productId, Long categoryId, Integer quantity, Map<String,String> orderItemAttributes)` Deprecated. Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
`FulfillmentGroup`	`createDefaultFulfillmentGroup(Order order, Address address)` Deprecated.
`DiscreteOrderItemRequest`	`createDiscreteOrderItemRequest(Long orderId, Long skuId, Long productId, Long categoryId, Integer quantity)` Deprecated. Not typically used in versions since 1.7.
`FulfillmentGroup`	`findDefaultFulfillmentGroupForOrder(Order order)` Deprecated.
`List<OrderPayment>`	`readPaymentInfosForOrder(Order order)` Deprecated.
`void`	`removeAllFulfillmentGroupsFromOrder(Order order)` Deprecated.
`void`	`removeAllFulfillmentGroupsFromOrder(Order order, boolean priceOrder)` Deprecated.
`void`	`removeFulfillmentGroupFromOrder(Order order, FulfillmentGroup fulfillmentGroup)` Deprecated.
`void`	`removeFulfillmentGroupFromOrder(Order order, FulfillmentGroup fulfillmentGroup, boolean priceOrder)` Deprecated.
`Order`	`removeItemFromBundle(Order order, BundleOrderItem bundle, OrderItem item, boolean priceOrder)` Deprecated.
`Order`	`removeItemFromOrder(Long orderId, Long itemId)` Deprecated.
`Order`	`removeItemFromOrder(Long orderId, Long itemId, boolean priceOrder)` Deprecated.
`Order`	`removeItemFromOrder(Order order, OrderItem item)` Deprecated.
`Order`	`removeItemFromOrder(Order order, OrderItem item, boolean priceOrder)` Deprecated.
`void`	`removeNamedOrderForCustomer(String name, Customer customer)` Deprecated.
`Order`	`removeOrderItemAttribute(Order order, OrderItem item, String attributeName, boolean priceOrder)` Deprecated. Adds the passed in name/value pair to the order-item.
`void`	`updateItemQuantity(Order order, OrderItem item)` Deprecated. Delegates to the fully parametrized method with priceOrder = true.
`void`	`updateItemQuantity(Order order, OrderItem item, boolean priceOrder)` Deprecated. Updates the quantity and reprices the order.
`void`	`updateItemQuantity(Order order, OrderItemRequestDTO orderItemRequestDTO)` Deprecated. From the given OrderItemRequestDTO object, this will look through the order's DiscreteOrderItems to find the item with the matching orderItemId and update this item's quantity with the value of the quantity field in the OrderItemRequestDTO.

Methods inherited from interface org.broadleafcommerce.core.order.service.OrderService
acquireLock, addAllItemsFromNamedOrder, addChildItems, addDependentOrderItem, addGiftWrapItemToOrder, addItem, addItemFromNamedOrder, addItemFromNamedOrder, addItemWithPriceOverrides, addOfferCode, addOfferCodes, addPaymentToOrder, cancelOrder, confirmOrder, createNamedOrderForCustomer, createNewCartForCustomer, deleteOrder, findCartForCustomer, findCartForCustomerWithEnhancements, findCartForCustomerWithEnhancements, findLastMatchingItem, findNamedOrderForCustomer, findOrderById, findOrderById, findOrderByOrderNumber, findOrdersByDateRange, findOrdersByEmail, findOrdersByIds, findOrdersForCustomer, findOrdersForCustomer, findOrdersForCustomersInDateRange, findPaymentsForOrder, getAutomaticallyMergeLikeItems, getNullOrder, getTotalChildOrderItems, isDeleteEmptyNamedOrders, isMoveNamedOrderItems, preValidateCartOperation, preValidateUpdateQuantityOperation, printOrder, readBatchOrders, readNumberOfOrders, refresh, releaseLock, reloadOrder, removeAllOfferCodes, removeAllPaymentsFromOrder, removeInactiveItems, removeItem, removeOfferCode, removePaymentFromOrder, removePaymentsFromOrder, save, save, setAutomaticallyMergeLikeItems, setDeleteEmptyNamedOrders, setMoveNamedOrderItems, updateItemQuantity, updateProductOptionsForItem

Method Detail

findDefaultFulfillmentGroupForOrder

FulfillmentGroup findDefaultFulfillmentGroupForOrder(Order order)

Deprecated.

addGiftWrapItemToOrder
```
OrderItem addGiftWrapItemToOrder(Order order,
                                 GiftWrapOrderItemRequest itemRequest)
                          throws PricingException
```
Deprecated.

Note: This method will automatically associate the given order to the given itemRequest such that then resulting OrderItem will already have an Order associated to it.

Parameters:

order -

itemRequest -

Returns:

Throws:

PricingException

addBundleItemToOrder
```
OrderItem addBundleItemToOrder(Order order,
                               BundleOrderItemRequest itemRequest)
                        throws PricingException
```
Deprecated.

Used to create dynamic bundles groupings of order items. Typically not used with ProductBundles which should instead call addProductToOrder. Prices the order after adding the bundle.

Parameters:

order -

itemRequest -

Returns:

Throws:

PricingException

addBundleItemToOrder
```
OrderItem addBundleItemToOrder(Order order,
                               BundleOrderItemRequest itemRequest,
                               boolean priceOrder)
                        throws PricingException
```
Deprecated.

Used to create dynamic bundles groupings of order items. Typically not used with ProductBundles which should instead call addProductToOrder. Prices the order after adding the bundle if priceOrder = true. Clients may wish to perform many cart operations without pricing and then use priceOrder = true on the last operation to avoid exercising the pricing engine in a batch order update mode. NOTE: this will automatically associate the given order to the given itemRequest such that the resulting OrderItem will already have the Order associated to it

Parameters:

order -

itemRequest -

priceOrder -

Returns:

Throws:

PricingException

addPaymentToOrder

OrderPayment addPaymentToOrder(Order order,
                               OrderPayment payment)

Deprecated.

addFulfillmentGroupToOrder

FulfillmentGroup addFulfillmentGroupToOrder(FulfillmentGroupRequest fulfillmentGroupRequest)
                                     throws PricingException

Deprecated.

Throws:: PricingException

addFulfillmentGroupToOrder

FulfillmentGroup addFulfillmentGroupToOrder(FulfillmentGroupRequest fulfillmentGroupRequest,
                                            boolean priceOrder)
                                     throws PricingException

Deprecated.

Throws:: PricingException

addFulfillmentGroupToOrder

FulfillmentGroup addFulfillmentGroupToOrder(Order order,
                                            FulfillmentGroup fulfillmentGroup)
                                     throws PricingException

Deprecated.

Throws:: PricingException

addFulfillmentGroupToOrder

FulfillmentGroup addFulfillmentGroupToOrder(Order order,
                                            FulfillmentGroup fulfillmentGroup,
                                            boolean priceOrder)
                                     throws PricingException

Deprecated.

Throws:: PricingException

addItemToFulfillmentGroup

FulfillmentGroup addItemToFulfillmentGroup(OrderItem item,
                                           FulfillmentGroup fulfillmentGroup,
                                           int quantity)
                                    throws PricingException

Deprecated.

Throws:: PricingException

addItemToFulfillmentGroup

FulfillmentGroup addItemToFulfillmentGroup(OrderItem item,
                                           FulfillmentGroup fulfillmentGroup,
                                           int quantity,
                                           boolean priceOrder)
                                    throws PricingException

Deprecated.

Throws:: PricingException

addItemToFulfillmentGroup

FulfillmentGroup addItemToFulfillmentGroup(OrderItem item,
                                           FulfillmentGroup fulfillmentGroup)
                                    throws PricingException

Deprecated.

Throws:: PricingException

addItemToFulfillmentGroup

FulfillmentGroup addItemToFulfillmentGroup(OrderItem item,
                                           FulfillmentGroup fulfillmentGroup,
                                           boolean priceOrder)
                                    throws PricingException

Deprecated.

Throws:: PricingException

addItemToFulfillmentGroup

FulfillmentGroup addItemToFulfillmentGroup(Order order,
                                           OrderItem item,
                                           FulfillmentGroup fulfillmentGroup,
                                           int quantity,
                                           boolean priceOrder)
                                    throws PricingException

Deprecated.

Throws:: PricingException

updateItemQuantity

void updateItemQuantity(Order order,
                        OrderItem item)
                 throws ItemNotFoundException,
                        PricingException

Deprecated.

Delegates to the fully parametrized method with priceOrder = true.

Parameters:: order -; item -
Throws:: ItemNotFoundException; PricingException

updateItemQuantity

void updateItemQuantity(Order order,
                        OrderItem item,
                        boolean priceOrder)
                 throws ItemNotFoundException,
                        PricingException

Deprecated.

Updates the quantity and reprices the order. Removes the orderItem if the quantity is updated to 0 (or less).

Parameters:: order -; item -; priceOrder -
Throws:: ItemNotFoundException; PricingException

updateItemQuantity
```
void updateItemQuantity(Order order,
                        OrderItemRequestDTO orderItemRequestDTO)
                 throws ItemNotFoundException,
                        PricingException
```
Deprecated.

From the given OrderItemRequestDTO object, this will look through the order's DiscreteOrderItems to find the item with the matching orderItemId and update this item's quantity with the value of the quantity field in the OrderItemRequestDTO.

Parameters:

order -

orderItemRequestDTO -

Throws:

ItemNotFoundException

PricingException

removeFulfillmentGroupFromOrder

void removeFulfillmentGroupFromOrder(Order order,
                                     FulfillmentGroup fulfillmentGroup)
                              throws PricingException

Deprecated.

Throws:: PricingException

removeFulfillmentGroupFromOrder

void removeFulfillmentGroupFromOrder(Order order,
                                     FulfillmentGroup fulfillmentGroup,
                                     boolean priceOrder)
                              throws PricingException

Deprecated.

Throws:: PricingException

removeItemFromOrder

Order removeItemFromOrder(Order order,
                          OrderItem item)
                   throws PricingException

Deprecated.

Throws:: PricingException

removeItemFromOrder

Order removeItemFromOrder(Order order,
                          OrderItem item,
                          boolean priceOrder)
                   throws PricingException

Deprecated.

Throws:: PricingException

removeNamedOrderForCustomer

void removeNamedOrderForCustomer(String name,
                                 Customer customer)

Deprecated.

removeAllFulfillmentGroupsFromOrder

void removeAllFulfillmentGroupsFromOrder(Order order)
                                  throws PricingException

Deprecated.

Throws:: PricingException

removeAllFulfillmentGroupsFromOrder

void removeAllFulfillmentGroupsFromOrder(Order order,
                                         boolean priceOrder)
                                  throws PricingException

Deprecated.

Throws:: PricingException

readPaymentInfosForOrder

List<OrderPayment> readPaymentInfosForOrder(Order order)

Deprecated.

removeItemFromOrder

Order removeItemFromOrder(Long orderId,
                          Long itemId)
                   throws PricingException

Deprecated.

Throws:: PricingException

removeItemFromOrder

Order removeItemFromOrder(Long orderId,
                          Long itemId,
                          boolean priceOrder)
                   throws PricingException

Deprecated.

Throws:: PricingException

createDefaultFulfillmentGroup

FulfillmentGroup createDefaultFulfillmentGroup(Order order,
                                               Address address)

Deprecated.

addItemToOrder
```
Order addItemToOrder(Long orderId,
                     OrderItemRequestDTO orderItemRequestDTO,
                     boolean priceOrder)
              throws PricingException
```
Deprecated.

Adds an item to the passed in order. The orderItemRequest can be sparsely populated. When priceOrder is false, the system will not reprice the order. This is more performant in cases such as bulk adds where the repricing could be done for the last item only.

Parameters:

orderItemRequestDTO -

priceOrder -

Returns:

Throws:

PricingException

See Also:

OrderItemRequestDTO

createDiscreteOrderItemRequest

DiscreteOrderItemRequest createDiscreteOrderItemRequest(Long orderId,
                                                        Long skuId,
                                                        Long productId,
                                                        Long categoryId,
                                                        Integer quantity)

Deprecated.

Not typically used in versions since 1.7. See: addItemToOrder(Long, OrderItemRequestDTO, boolean)

Parameters:: orderId -; skuId -; productId -; categoryId -; quantity -
Returns:

addOrUpdateOrderItemAttributes
```
Order addOrUpdateOrderItemAttributes(Order order,
                                     OrderItem item,
                                     Map<String,String> attributeValues,
                                     boolean priceOrder)
                              throws ItemNotFoundException,
                                     PricingException
```
Deprecated.

Adds the passed in name/value pair to the order-item. If the attribute already exists, then it is updated with the new value. If the value passed in is null or empty string and the attribute exists, it is removed from the order item. You may wish to set priceOrder to false if performing set of cart operations to avoid the expense of exercising the pricing engine until you are ready to finalize pricing after adding the last item.

Parameters:

order -

item -

attributeValues -

priceOrder -

Returns:

Throws:

ItemNotFoundException

PricingException

removeOrderItemAttribute
```
Order removeOrderItemAttribute(Order order,
                               OrderItem item,
                               String attributeName,
                               boolean priceOrder)
                        throws ItemNotFoundException,
                               PricingException
```
Deprecated.

Adds the passed in name/value pair to the order-item. If the attribute already exists, then it is updated with the new value. If the value passed in is null and the attribute exists, it is removed from the order item. You may wish to set priceOrder to false if performing set of cart operations to avoid the expense of exercising the pricing engine until you are ready to finalize pricing after adding the last item.

Parameters:

order -

item -

attributeName -

priceOrder -

Returns:

Throws:

ItemNotFoundException

PricingException