Package com.softslate.commerce.businessobjects.order

Interface OrderProcessor

All Superinterfaces:

BusinessObject, BusinessProcessor

All Known Implementing Classes:

BasicOrderProcessor

public interface OrderProcessor
extends BusinessProcessor

Interface for business logic methods affecting orders and other related objects.

When the application needs to create an instance that implements OrderProcessor, BusinessObjectFactory finds the name of the Java class to instantiate from the "orderProcessorImplementer" setting in the appComponents.properties file.

The default "orderProcessorImplementer" is BasicOrderProcessor.

Author:

David Tobey

Method Summary

Modifier and Type	Method	Description
Map	addOrder(Map parameters)
int	deleteIncompleteOrders(Map parameters)
void	deleteOrder(Map parameters)
Order	duplicateOrder(Order order)	Duplicates an Order object.
Map	editDeleteOrders(Map parameters)
Map	editOrder(Map parameters)
Collection<Order>	loadAbandonedCartOrders(String startDate, String endDate, String prevOrdersDate)
Collection<Order>	loadCompletedOrdersByDateRange(String startDate, String endDate, Collection<String> ignoreStatuses)
Collection<Order>	loadCompletedOrdersByLastModifiedAndStatuses(String startDate, String endDate, Collection<String> currentStatuses)
Collection	loadDashboardStatistics()
Collection	loadIncompleteOrdersStatistics()
Collection	loadIncompleteOrdersWithPayments(Map parameters)	Queries the system to find orders which have payments but have not been marked complete.
int	loadMaxOrderID()
Order	loadOrderDetails(int orderNumber)
Order	loadOrderFromID(Map parameters)
Order	loadOrderFromNumber(int orderNumber)
Order	loadOrderFromNumber(Map parameters)
Map	loadOrdersAndCount(Map parameters)
Map	loadSavedCartFromToken(Map parameters)
StatesAndCountries	loadStatesAndCountries()	Loads the store's states and countries from the database.
Map	postChangedOrderEvent(Order order, Map parameters)
Map	postChangingOrderEvent(Order item, Map parameters)
Map	reprocessOrder(Order order)	Reprocesses the items in an Order object by adding them to the user's current cart.

Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessObject

initialize

Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessProcessor

getAppComponents, getAppSettings, getBusinessObjectFactory, getDaoFactory, getEventBus, getInjector, getSettings, getUser, setAppComponents, setAppSettings, setBusinessObjectFactory, setDaoFactory, setEventBus, setInjector, setSettings, setUser, utils

Method Details

loadStatesAndCountries

StatesAndCountries loadStatesAndCountries()
                                   throws Exception

Loads the store's states and countries from the database. The Struts layer calls this method when the application starts. The data is kept in the servlet's application scope and displayed to users filling in address information.

Returns:

A StatesAndCountries object containing Collection s of the store's states and countries.

Throws:

Exception

loadDashboardStatistics

Collection loadDashboardStatistics()
                            throws Exception

Throws:

Exception

loadIncompleteOrdersStatistics

Collection loadIncompleteOrdersStatistics()
                                   throws Exception

Throws:

Exception

deleteIncompleteOrders

int deleteIncompleteOrders(Map parameters)
                    throws Exception

Throws:

Exception

loadOrdersAndCount

Map loadOrdersAndCount(Map parameters)
                throws Exception

Throws:

Exception

addOrder

Map addOrder(Map parameters)
      throws Exception

Throws:

Exception

loadOrderFromID

Order loadOrderFromID(Map parameters)
               throws Exception

Throws:

Exception

editOrder

Map editOrder(Map parameters)
       throws Exception

Throws:

Exception

editDeleteOrders

Map editDeleteOrders(Map parameters)
              throws Exception

Throws:

Exception

deleteOrder

void deleteOrder(Map parameters)
          throws Exception

Throws:

Exception

loadOrderDetails

Order loadOrderDetails(int orderNumber)
                throws Exception

Throws:

Exception

loadSavedCartFromToken

Map loadSavedCartFromToken(Map parameters)
                    throws Exception

Throws:

Exception

loadMaxOrderID

int loadMaxOrderID()
            throws Exception

Throws:

Exception

duplicateOrder

Order duplicateOrder(Order order)
              throws Exception

Duplicates an Order object. Performs a deep copy of its dependancies (excluding primary keys). Used for picking up saved carts.

Parameters:

order - The Order to be duplicated.

Returns:

The duplicated Order object.

Throws:

Exception

reprocessOrder

Map reprocessOrder(Order order)
            throws Exception

Reprocesses the items in an Order object by adding them to the user's current cart. Used for picking up saved carts.

Parameters:

order - The Order whose items are to be reprocessed.

Returns:

a Map containing the results of the reprocessing.

Throws:

Exception

loadIncompleteOrdersWithPayments

Collection loadIncompleteOrdersWithPayments(Map parameters)
                                     throws Exception

Queries the system to find orders which have payments but have not been marked complete. This conditions indicates that a payment was submitted but something went wrong during the process.

Parameters:

parameters - A Map containing String values olderThanDays, olderThanHours which can be parsed to an Integer.

Returns:

a Collection containing the orders if any.

Throws:

Exception

postChangingOrderEvent

Map postChangingOrderEvent(Order item,
 Map parameters)
                    throws Exception

Throws:

Exception

postChangedOrderEvent

Map postChangedOrderEvent(Order order,
 Map parameters)
                   throws Exception

Throws:

Exception

loadOrderFromNumber

Order loadOrderFromNumber(Map parameters)
                   throws Exception

Throws:

Exception

loadOrderFromNumber

Order loadOrderFromNumber(int orderNumber)
                   throws Exception

Throws:

Exception

loadCompletedOrdersByDateRange

Collection<Order> loadCompletedOrdersByDateRange(String startDate,
 String endDate,
 Collection<String> ignoreStatuses)
                                          throws Exception

Throws:

Exception

loadAbandonedCartOrders

Collection<Order> loadAbandonedCartOrders(String startDate,
 String endDate,
 String prevOrdersDate)
                                   throws Exception

Throws:

Exception

loadCompletedOrdersByLastModifiedAndStatuses

Collection<Order> loadCompletedOrdersByLastModifiedAndStatuses(String startDate,
 String endDate,
 Collection<String> currentStatuses)
                                                        throws Exception

Throws:

Exception