com.neurosys.ecom.orders.service

Interface OrderService<O extends Order<? extends I>,I extends OrderItem>

Type Parameters:

O - as Order

I - as OrderItem

All Superinterfaces:

ChangeGenerator<Object>

All Known Subinterfaces:

RelatedOrderService<O,I>, SubOrderService<O,I>

All Known Implementing Classes:

DefaultOrderService, DefaultSubOrderService

public interface OrderService<O extends Order<? extends I>,I extends OrderItem>
extends ChangeGenerator<Object>

Handle all requests related or Order management
This class will also generate Events (See implementation for specifics)

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
void	adjustInventory(I item, Number updateCnt, String causeSource) Using a + or a - value for countUpdate we can change the Stock position from its current position.
void	checkItemProductsStillLocked(O order) For some operations like sending invoice etc it may be necessary for the order to have a lock on all its products; Warn by throwing PartialTransactionException.getFailed() of all Products that are not locked.
OrderDao<O>	getDao() The Actions on the service layer can trigger events. Useful if we want to easily create intermediate save points without having to worry about triggering events.
boolean	isExists(Long orderId) Check to see if an Order exists or not
O	load(Long orderId) Load an existing Order
void	lockProductsForOrder(O order, String causeSource) Orders maintain referential integrity over Products that are used by them.
<D extends DeliveryDetails> D	save(D deliveryDetails, String causeSource) Explicitly update the Delivery Details only
<T extends O> T	save(T order, String causeSource, Object... context) Save the Order and process any Strategy @ an Order level
void	unlockProductsForOrder(O order, String causeSource) Orders maintain referential integrity over Products that are used by them.
I	update(I item, String causeSource) Save the OrderItem and process any Strategy @ an OrderItem level

Methods inherited from interface com.neurosys.events.ChangeGenerator

addChangeListener, getListeners, notifyAllListeners, setListeners

Method Detail

save

<T extends O> T save(T order,
                     String causeSource,
                     Object... context)
              throws OrderPlacementException

Save the Order and process any Strategy @ an Order level

Parameters:

order - as Order

causeSource - as Source of Change @nullable true will cause no subsequent event firing

propagateNotificatons - as boolean; if false will NOT call event listeners. This can be useful to prevent recursion from Event-Listeners

context - as Object varags; typically sent to the ChangeGenerator.getListeners()

Returns:

same or new Order object

Throws:

OrderPlacementException

load

O load(Long orderId)

Load an existing Order

Parameters:

orderId - as Long

Returns:

isExists

boolean isExists(Long orderId)

Check to see if an Order exists or not

Parameters:

orderId -

Returns:

update

I update(I item,
         String causeSource)
  throws OrderPlacementException

Save the OrderItem and process any Strategy @ an OrderItem level

Parameters:

item - as OrderItem

causeSource - as Source of Change @nullable true will cause no subsequent event firing

Returns:

same or new OrderItem object

Throws:

OrderPlacementException

save

<D extends DeliveryDetails> D save(D deliveryDetails,
                                   String causeSource)

Explicitly update the Delivery Details only

Parameters:

deliveryDetails - as DeliveryDetails

causeSource - as Source of Change @nullable true will cause no subsequent event firing

Returns:

lockProductsForOrder

void lockProductsForOrder(O order,
                          String causeSource)
                   throws PartialTransactionException,
                          OrderPlacementException

Orders maintain referential integrity over Products that are used by them.
Lock the Products that belong to the OrderItems in the Order

Parameters:

order - as Order

causeSource - as String @nullable true will cause no subsequent event firing

Throws:

PartialTransactionException

OrderPlacementException

unlockProductsForOrder

void unlockProductsForOrder(O order,
                            String causeSource)
                     throws OrderPlacementException

Orders maintain referential integrity over Products that are used by them.
Un-Lock the Products that belong to the OrderItems in the Order

Parameters:

order - as Order

causeSource - @nullable true will cause no subsequent event firing

Throws:

OrderPlacementException

checkItemProductsStillLocked

void checkItemProductsStillLocked(O order)
                           throws PartialTransactionException

For some operations like sending invoice etc it may be necessary for the order to have a lock on all its products; Warn by throwing PartialTransactionException.getFailed() of all Products that are not locked.

Parameters:

order -

Throws:

PartialTransactionException

adjustInventory

void adjustInventory(I item,
                     Number updateCnt,
                     String causeSource)

Using a + or a - value for countUpdate we can change the Stock position from its current position.

When calling multiple adjustInventory(OrderItem, Number, String) for an Order ensure they are called within one Transaction.
Note: This method may throw RuntimeExceptions if Products don't exist, difficulty in modifying count on underlying DB etc; so any calling API Post Order placement should ideally account for RuntimeException use cases

Parameters:

item - as OrderItem

updateCnt - as Number (Integer) that will be adjusted from the current stock position. A position # will ADD to current position, Negative will deduct from current position. Note: The update count is not an absolute position; this is to ensure in high volume cases the Adjustments dont overwrite each other and each transaction is responsible for its own adjustment.

causeSource - as String @nullable true will cause no subsequent event firing

getDao

OrderDao<O> getDao()

The Actions on the service layer can trigger events.
Useful if we want to easily create intermediate save points without having to worry about triggering events.

Returns: