com.beasys.commerce.ebusiness.order
Interface OrderManager

All Superinterfaces:

EJBObject, Remote

public interface OrderManager

extends EJBObject

The OrderManagerBean is a session bean that isolates the JSP type calls from dealing directly with Order Entity Beans in a piece-meal fashion and improves performance by keeping the calls on the EJB sides.
Its main purpose is to create an Order and to retrieve OrderValue's using a variety of criteria, customerPK, a date range, a SKU, a Status.
The returned objects on those finder methods may be either straight collection with all the orderValue objects filled, or a more sophisticated ScrollableModel which caches the PK and a few orderValues only.
Finally, the OrderManagerBean deals with getting and setting an Order's status, and helps the JSP presentation by providing the only possible statuses an Order can move to.
stereotype SessionBean
homeInterface com.beasys.commerce.ebusiness.order.OrderManagerHome
remoteInterface com.beasys.commerce.ebusiness.order.OrderManager

See Also:

OrderValue, StateMachine, ScrollableModel

Method Summary

Handle	createOrder(OrderPk orderPK, OrderValue orderValue, Quote adjustments) Creates an order using a previously generated primary key and an order value via a Handle.
Collection	findByCustomer(CustomerPk customerPK) Finds the overValues associated with a customer and returns a collection
ScrollableModel	findByCustomer(CustomerPk customerPK, int pageSize) Finds the overValues associated with a customer and returns a scrollable model
Collection	findByDates(Date startDate, Date endDate) Finds the overValues associated with a date range and returns a collection
ScrollableModel	findByDates(Date startDate, Date endDate, int pageSize) Finds the overValues associated with a date range and returns a scrollable model
OrderValue	findByPK(OrderPk orderPK) Finds the order value associated with a particular primary key, a basic finder method.
Collection	findBySKU(String SKU) Finds the overValues associated with a SKU and returns a collection
ScrollableModel	findBySKU(String sku, int pageSize) Finds the overValues associated with a SKU and returns a scrollable model
Collection	findByStatus(String status) Finds the overValues associated with a status and returns a collection
ScrollableModel	findByStatus(String status, int pageSize) Finds the overValues associated with a status and returns a scrollable model
String	getOrderStatus(OrderPk orderPK) Gets the status of an order based on its PK
String[]	getValidNewStatuses(OrderPk orderPK) Gets all the valid status an order can move to.
void	queryOrderAdjusments(OrderPk orderPK, OrderValue orderValue) this call fills an orderValue with the adjustments that are associated with it.
void	setOrderStatus(OrderPk orderPK, String status) Sets an order status
void	updateOrderDiscounts(OrderPk orderPk, OrderValue orderValue, Quote adjustments) updates the discounts associated with an order

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

createOrder

public Handle createOrder(OrderPk orderPK,
                          OrderValue orderValue,
                          Quote adjustments)
                   throws RemoteException

Creates an order using a previously generated primary key and an order value via a Handle.

Parameters:

orderPK -

Returns:

the handle over the order entity bean.

Throws:

RemoteException

findByCustomer

public Collection findByCustomer(CustomerPk customerPK)
                          throws RemoteException

Finds the overValues associated with a customer and returns a collection

Returns:

the Collection that manages the corresponding Order values

Throws:

RemoteException

findByCustomer

public ScrollableModel findByCustomer(CustomerPk customerPK,
                                      int pageSize)
                               throws RemoteException

Finds the overValues associated with a customer and returns a scrollable model

Returns:

the ScrollableModel that manages the corresponding Order values

Throws:

RemoteException

findByDates

public Collection findByDates(Date startDate,
                              Date endDate)
                       throws RemoteException

Finds the overValues associated with a date range and returns a collection

Parameters:

startDate - of the date range

endDate - of the date range

Returns:

the collection that manages the corresponding Order values

Throws:

RemoteException

findByDates

public ScrollableModel findByDates(Date startDate,
                                   Date endDate,
                                   int pageSize)
                            throws RemoteException

Finds the overValues associated with a date range and returns a scrollable model

Parameters:

startDate - of the date range

endDate - of the date range

Returns:

the ScrollableModel that manages the corresponding Order values

Throws:

RemoteException

findByPK

public OrderValue findByPK(OrderPk orderPK)
                    throws RemoteException

Finds the order value associated with a particular primary key, a basic finder method.

Returns:

the corresponding order value object.

Throws:

RemoteException

findBySKU

public Collection findBySKU(String SKU)
                     throws RemoteException

Finds the overValues associated with a SKU and returns a collection

Returns:

the collection that manages the corresponding Order values

Throws:

RemoteException

findBySKU

public ScrollableModel findBySKU(String sku,
                                 int pageSize)
                          throws RemoteException

Finds the overValues associated with a SKU and returns a scrollable model

Returns:

the ScrollableModel that manages the corresponding Order values

Throws:

RemoteException

findByStatus

public Collection findByStatus(String status)
                        throws RemoteException

Finds the overValues associated with a status and returns a collection

Returns:

the collection that manages the corresponding Order values

Throws:

RemoteException

findByStatus

public ScrollableModel findByStatus(String status,
                                    int pageSize)
                             throws RemoteException

Finds the overValues associated with a status and returns a scrollable model

Returns:

the ScrollableModel that manages the corresponding Order values

Throws:

RemoteException

getOrderStatus

public String getOrderStatus(OrderPk orderPK)
                      throws RemoteException

Gets the status of an order based on its PK

Parameters:

orderPK -

Returns:

the status as a String

Throws:

RemoteException

getValidNewStatuses

public String[] getValidNewStatuses(OrderPk orderPK)
                             throws RemoteException

Gets all the valid status an order can move to.

Parameters:

orderPK -

Returns:

a String array, one string per valid new status

Throws:

RemoteException

queryOrderAdjusments

public void queryOrderAdjusments(OrderPk orderPK,
                                 OrderValue orderValue)
                          throws RemoteException

this call fills an orderValue with the adjustments that are associated with it.

Throws:

RemoteException

setOrderStatus

public void setOrderStatus(OrderPk orderPK,
                           String status)
                    throws RemoteException

Sets an order status

Parameters:

orderPK -

status -

Returns:

void

Throws:

RemoteException

updateOrderDiscounts

public void updateOrderDiscounts(OrderPk orderPk,
                                 OrderValue orderValue,
                                 Quote adjustments)
                          throws RemoteException

updates the discounts associated with an order

Parameters:

orderPk - the order primary key.

orderValue - the order value which contains the creation date and the orderline

adjustments - a Quote object containing the adjustments

Throws:

RemoteException

Since:

WLCS 3.5 sp3, added as a customer support case