Package com.softslate.commerce.businessobjects.order

Interface InventoryProcessor

All Superinterfaces:

BusinessObject, BusinessProcessor

All Known Implementing Classes:

BasicInventoryProcessor

public interface InventoryProcessor
extends BusinessProcessor

Interface for business logic methods having to do with SKUs and inventory.

CartProcessor employs an instance implementing InventoryProcessor when inventory needs to be processed.

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

The default "inventoryProcessorImplementer" is BasicInventoryProcessor.

Method Summary

Modifier and Type	Method	Description
Map	defineInventorySettings(Product product, Collection attributeSKUCollection)	Inspects a Product and returns a Map of useful variables related to the state of the product's inventory.
Map	processAddItems(Collection orderItems)	Processes inventory as new OrderItems are added to a user's cart.
Map	processInventory(Collection orderItems, Map productSettings, Collection matchingSkus, String decrementBehavior)	Generically processes inventory, returning a Map with information about items and skus.
Map	processOnCheckout(Map parameters)	Checks inventory for a user's cart during checkout.
Map	processOrderComplete(Map parameters)	Processes inventory for a user's cart as an order is completed.

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

processAddItems

Map processAddItems(Collection orderItems)
             throws Exception

Processes inventory as new OrderItems are added to a user's cart. Decrements inventory levels (in the memory objects) if products are set to be decremented upon being added to a cart. (Objects are updated in the database by BasicCartProcessor.processAddItems(Collection), which is what calls this method.)

The default implementation of this method does the following:

1. Loads the inventory settings in effect for each of the products corresponding to the OrderItems being added.
2. Calls BaseBusinessProcessor.loadMatchingSkus(Collection, Collection, Collection) to load the skus corresponding to the OrderItems.
3. Calls processInventory(Collection, Map, Collection, String) to process the inventory.
4. Removes any order items that were rejected because one of their corresponding SKUs are out of stock.
5. Adjusts the quantities of any order items whose quantities exceed the quantity in stock.
6. Calls CartProcessor.processQuantities(Collection) to update the cart with the new quantities.

Parameters:

orderItems - The Collection of OrderItem objects being added to the cart.

Returns:

A Map containing results of the processing. In the default implementation, the Map is the same as the one returned by processInventory(Collection, Map, Collection, String) (which this method calls).

Throws:

Exception

See Also:

• BasicCartProcessor.processAddItems(Collection)

processOnCheckout

Map processOnCheckout(Map parameters)
               throws Exception

Checks inventory for a user's cart during checkout. This step takes places as the user passes through checkout, but before submitting payment information. Makes sure that if products are to be decremented on checkout, no skus are out of stock. Inventory does not get decremented with this method.

The default implementation of this method largely follows the same steps as processAddItems(Collection).

Parameters:

parameters - The most recent parameters submitted by the user.

Returns:

A Map containing results of the processing. In the default implementation, the Map is the same as the one returned by processInventory(Collection, Map, Collection, String) (which this method calls).

Throws:

Exception

See Also:

• CheckoutAction.processInventoryDiscountCheck(BaseForm)

processOrderComplete

Map processOrderComplete(Map parameters)
                  throws Exception

Processes inventory for a user's cart as an order is completed. This step takes place after a successful payment processing. Inventory is decremented at this point for products set to be decremented on checkout.

Parameters:

parameters - The most recent parameters submitted by the user.

Returns:

A Map containing results of the processing. In the default implementation, the Map is the same as the one returned by processInventory(Collection, Map, Collection, String) (which this method calls).

Throws:

Exception

processInventory

Map processInventory(Collection orderItems,
 Map productSettings,
 Collection matchingSkus,
 String decrementBehavior)
              throws Exception

Generically processes inventory, returning a Map with information about items and skus. Does not change the order items being checked.

Parameters:

orderItems - A Collection of OrderItem objects being processed.

productSettings - A Map of Collections representing the inventory settings in effect for the products in the OrderItems.

matchingSkus - A Collection of Maps representing all the SKUs associated with the OrderItems.

decrementBehavior - A String representing when inventory is to be decremented. Either "onAddingToCart" or "onOrderCompletion".

Returns:

A Map containing results of the processing. In the default implementation, the keys of the Map include:

• skusToDecrement: A Collection of Maps, each representing a SKU that is to be decremented as result of the processing.
• decrementedSKUs: A Map whose keys are OrderItem objects and whose values are comma-separated Strings representing the ids of the SKU objects corresponding to the OrderItem that are to be decremented. (Used to populate the OrderItem's descrementedSKUs property.)
• rejectedOrderItems: A Collection of OrderItem objects that have been removed from the user's cart due to their being out of stock.
• adjustedQuantities: A Map whose keys are OrderItem objects and whose values are Strings representing the OrderItems new quantity, after being adjusted because not enough inventory is available.
• newOOSSKUs: A Collection of Maps, each representing a SKU that has just reached its out of stock level as result of the processing.
• productsToDeactivate: A Collection of Strings, each representing the id of a Product object that should now be deactivated because a SKU associated with it has just gone out of stock.
• lowStockEmails: A Collection of Maps, each representing a SKU that has reached its 'low stock' level, and should trigger a low stock email as a result.

Throws:

Exception

defineInventorySettings

Map defineInventorySettings(Product product,
 Collection attributeSKUCollection)

Inspects a Product and returns a Map of useful variables related to the state of the product's inventory.

Parameters:

product -

attributeSKUCollection - An optional Collection of attribute-only SKUs used to define the inventory settings that are returned.

Returns:

A Map of variables related to the product's inventory.