org.broadleafcommerce.core.order.dao

Interface OrderDao

All Known Implementing Classes:

OrderDaoImpl

public interface OrderDao

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acquireLock(Order order) This method will attempt to update the OrderLock object table for the given order to mark it as locked, provided the OrderLock record for the given order was not already locked.
Order	create()
Order	createNewCartForCustomer(Customer customer)
void	delete(Order order)
List<Order>	findCarts(String[] names, OrderStatus[] statuses, Date dateCreatedMinThreshold) Deletes carts from the database.
Order	readCartForCustomer(Customer customer)
Order	readNamedOrderForCustomer(Customer customer, String name)
Order	readOrderById(Long orderId)
Order	readOrderById(Long orderId, boolean refresh)
Order	readOrderByOrderNumber(String orderNumber)
List<Order>	readOrdersForCustomer(Customer customer, OrderStatus orderStatus)
List<Order>	readOrdersForCustomer(Long id)
boolean	releaseLock(Order order) Releases the lock for the given order.
Order	save(Order order)
Order	submitOrder(Order cartOrder)
Order	updatePrices(Order order)

Method Detail

readOrderById

Order readOrderById(Long orderId)

readOrderById

Order readOrderById(Long orderId,
                  boolean refresh)

readOrdersForCustomer

List<Order> readOrdersForCustomer(Customer customer,
                                OrderStatus orderStatus)

readOrdersForCustomer

List<Order> readOrdersForCustomer(Long id)

readNamedOrderForCustomer

Order readNamedOrderForCustomer(Customer customer,
                              String name)

readCartForCustomer

Order readCartForCustomer(Customer customer)

save

Order save(Order order)

delete

void delete(Order order)

submitOrder

Order submitOrder(Order cartOrder)

create

Order create()

createNewCartForCustomer

Order createNewCartForCustomer(Customer customer)

readOrderByOrderNumber

Order readOrderByOrderNumber(String orderNumber)

updatePrices

Order updatePrices(Order order)

findCarts

List<Order> findCarts(String[] names,
                    OrderStatus[] statuses,
                    Date dateCreatedMinThreshold)

Deletes carts from the database. Carts are generally considered orders that have not made it to the submitted status. The method parameters can be left null, or included to refine the deletion criteria. Note, if statuses are null, the query defaults to selecting only orders that have a status of IN_PROCESS.

Parameters:

names - One or more order names to restrict the deletion by. Can be null.

statuses - One or more order statuses to restrict the deletion by. Can be null.

dateCreatedMinThreshold - Min creation date to restrict the deletion by. Orders created before this date are removed. Can be null.

Returns:

the number of deleted carts

acquireLock

boolean acquireLock(Order order)

This method will attempt to update the OrderLock object table for the given order to mark it as locked, provided the OrderLock record for the given order was not already locked. It will return true or false depending on whether or not the lock was able to be acquired.

Parameters:

order -

Returns:

true if the lock was acquired, false otherwise

releaseLock

boolean releaseLock(Order order)

Releases the lock for the given order. Note that this method will release the lock for the order whether or not the caller was the current owner of the lock. As such, callers of this method should take care to ensure they hold the lock before attempting to release it.

Parameters:

order -

Returns:

true if the lock was successfully released, false otherwise