Package com.softslate.commerce.businessobjects.shipping

Class BasicShippingRuleProcessor

java.lang.Object

com.softslate.commerce.businessobjects.core.BaseBusinessObject

com.softslate.commerce.businessobjects.core.BaseBusinessProcessor

com.softslate.commerce.businessobjects.shipping.BasicShippingRuleProcessor

All Implemented Interfaces:

BusinessObject, BusinessProcessor, ShippingRuleProcessor

public class BasicShippingRuleProcessor
extends BaseBusinessProcessor
implements ShippingRuleProcessor

Processes business logic having to do with shipping rules. Created in the Struts layer in response to requests for viewing, editing, adding, and deleting discounts.

BasicShippingRuleProcessor is the default implementation of the ShippingRuleProcessor interface for the application.

Author:

Jason McWilliams

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor	Description
BasicShippingRuleProcessor()

Method Summary

Modifier and Type	Method	Description
Map	addShippingRule(Map parameters)
void	applyDiscount(Map method, OrderShippingRule osr)
void	applyDiscountToMatchingMethods(Collection availableMethods, OrderShippingRule osr)
void	applyDiscountToNotMatchingMethods(Collection availableMethods, OrderShippingRule osr)
void	applyShippingDiscountsToAvailableMethods(Collection orderShippingRules, Collection availableMethods)
void	createGlobalOrderShippingRule(ShippingRule sr, ShippingRuleRange srr)
void	createLeftOverPackage(int quantity, double weight, double leftOverTotal)
void	createMethodLimit(ShippingRule sr, ShippingRuleRange srr, OrderItem oi)
int	createPackage(ShippingRule sr, ShippingRuleRange srr, OrderItem oi, int currentQuantity, boolean firstRule)
void	createPossibleDiscount(ShippingRule sr, ShippingRuleRange srr, OrderItem oi)
void	deleteShippingRule(Map parameters)
boolean	doesLimitByLocationRuleApply(OrderShippingRule osr)
Map	editDeleteShippingRules(Map parameters)
Map	editShippingRule(Map parameters)
Collection	findAvailableShippingProcessors(Collection availableMethods, int orderID)
Collection	getLimitByLocationShippingRules()
Collection	getShippingRulesBySkuIDs(Collection skuIDs)
Collection	getSkuIDs(OrderItem oi, Collection matchingSkus)
boolean	isShippingRuleOk(ShippingRule shippingRule, OrderItem oi)
ShippingRule	loadShippingRuleFromID(Map parameters)
Map	loadShippingRulesAndCount(Map parameters)
Map	processAddItems(Collection newOrderItems)
void	processAllowMethods(Collection orderShippingRules, Collection availableMethods)
Map	processEditItem(Collection newOrderItems)
Map	processGlobalShippingRules()
void	processMethodLimits(OrderItem oi, Collection rules)
Map	processOnCheckout(Map parameters)
Map	processOrderComplete(Map parameters)
int	processPackages(OrderItem oi, Collection rules)
void	processPossibleDiscounts(OrderItem oi, Collection rules)
Map	processRemoveAllRules()
Map	processShippingRules(Collection newOrderItems)
Map	processSkuShippingRules(Collection orderItems)
boolean	rangeMatch(ShippingRuleRange srr, OrderItem oi)
void	removeShippingMethodFromAvailableList(Collection hasToBe, Collection availableMethods)
void	removeShippingMethodFromAvailableList(Map removeMethod, Collection availableMethods)

Methods inherited from class com.softslate.commerce.businessobjects.core.BaseBusinessProcessor

formatDateTime, formatPrice, getAppComponents, getAppSettings, getAttributeIDs, getBusinessObjectFactory, getDaoFactory, getEventBus, getInjector, getProductIDs, getSettings, getUser, initialize, isProcessorClassActive, loadMatchingSkus, parseDateTime, parseResponseData, prepareRequestData, sendHTTPGet, sendHTTPPost, sendHTTPPost, setAppComponents, setAppSettings, setBusinessObjectFactory, setDaoFactory, setEventBus, setInjector, setSettings, setUser, updateOrderTotals, updateOrderTotals, updateOrderTotals, utils

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Field Details

log

static org.apache.commons.logging.Log log

Constructor Details

BasicShippingRuleProcessor

public BasicShippingRuleProcessor()

Method Details

loadShippingRulesAndCount

public Map loadShippingRulesAndCount(Map parameters)
                              throws Exception

Specified by:

loadShippingRulesAndCount in interface ShippingRuleProcessor

Throws:

Exception

addShippingRule

public Map addShippingRule(Map parameters)
                    throws Exception

Specified by:

addShippingRule in interface ShippingRuleProcessor

Throws:

Exception

loadShippingRuleFromID

public ShippingRule loadShippingRuleFromID(Map parameters)
                                    throws Exception

Specified by:

loadShippingRuleFromID in interface ShippingRuleProcessor

Throws:

Exception

editShippingRule

public Map editShippingRule(Map parameters)
                     throws Exception

Specified by:

editShippingRule in interface ShippingRuleProcessor

Throws:

Exception

editDeleteShippingRules

public Map editDeleteShippingRules(Map parameters)
                            throws Exception

Specified by:

editDeleteShippingRules in interface ShippingRuleProcessor

Throws:

Exception

deleteShippingRule

public void deleteShippingRule(Map parameters)
                        throws Exception

Specified by:

deleteShippingRule in interface ShippingRuleProcessor

Throws:

Exception

findAvailableShippingProcessors

public Collection findAvailableShippingProcessors(Collection availableMethods,
 int orderID)
                                           throws Exception

Specified by:

findAvailableShippingProcessors in interface ShippingRuleProcessor

Throws:

Exception

applyShippingDiscountsToAvailableMethods

public void applyShippingDiscountsToAvailableMethods(Collection orderShippingRules,
 Collection availableMethods)
                                              throws Exception

Throws:

Exception

applyDiscount

public void applyDiscount(Map method,
 OrderShippingRule osr)
                   throws Exception

Throws:

Exception

applyDiscountToMatchingMethods

public void applyDiscountToMatchingMethods(Collection availableMethods,
 OrderShippingRule osr)
                                    throws Exception

Throws:

Exception

applyDiscountToNotMatchingMethods

public void applyDiscountToNotMatchingMethods(Collection availableMethods,
 OrderShippingRule osr)
                                       throws Exception

Throws:

Exception

processAllowMethods

public void processAllowMethods(Collection orderShippingRules,
 Collection availableMethods)
                         throws Exception

Throws:

Exception

removeShippingMethodFromAvailableList

public void removeShippingMethodFromAvailableList(Collection hasToBe,
 Collection availableMethods)
                                           throws Exception

Throws:

Exception

removeShippingMethodFromAvailableList

public void removeShippingMethodFromAvailableList(Map removeMethod,
 Collection availableMethods)
                                           throws Exception

Throws:

Exception

processOrderComplete

public Map processOrderComplete(Map parameters)
                         throws Exception

Specified by:

processOrderComplete in interface ShippingRuleProcessor

Throws:

Exception

processEditItem

public Map processEditItem(Collection newOrderItems)
                    throws Exception

Specified by:

processEditItem in interface ShippingRuleProcessor

Throws:

Exception

processAddItems

public Map processAddItems(Collection newOrderItems)
                    throws Exception

Specified by:

processAddItems in interface ShippingRuleProcessor

Throws:

Exception

processOnCheckout

public Map processOnCheckout(Map parameters)
                      throws Exception

Specified by:

processOnCheckout in interface ShippingRuleProcessor

Throws:

Exception

processShippingRules

public Map processShippingRules(Collection newOrderItems)
                         throws Exception

Specified by:

processShippingRules in interface ShippingRuleProcessor

Throws:

Exception

processGlobalShippingRules

public Map processGlobalShippingRules()
                               throws Exception

Throws:

Exception

processSkuShippingRules

public Map processSkuShippingRules(Collection orderItems)
                            throws Exception

Throws:

Exception

getLimitByLocationShippingRules

public Collection getLimitByLocationShippingRules()
                                           throws Exception

Throws:

Exception

doesLimitByLocationRuleApply

public boolean doesLimitByLocationRuleApply(OrderShippingRule osr)
                                     throws Exception

Throws:

Exception

createGlobalOrderShippingRule

public void createGlobalOrderShippingRule(ShippingRule sr,
 ShippingRuleRange srr)
                                   throws Exception

Throws:

Exception

rangeMatch

public boolean rangeMatch(ShippingRuleRange srr,
 OrderItem oi)
                   throws Exception

Throws:

Exception

processPackages

public int processPackages(OrderItem oi,
 Collection rules)
                    throws Exception

Throws:

Exception

processPossibleDiscounts

public void processPossibleDiscounts(OrderItem oi,
 Collection rules)
                              throws Exception

Throws:

Exception

processMethodLimits

public void processMethodLimits(OrderItem oi,
 Collection rules)
                         throws Exception

Throws:

Exception

createLeftOverPackage

public void createLeftOverPackage(int quantity,
 double weight,
 double leftOverTotal)
                           throws Exception

Throws:

Exception

createPackage

public int createPackage(ShippingRule sr,
 ShippingRuleRange srr,
 OrderItem oi,
 int currentQuantity,
 boolean firstRule)
                  throws Exception

Throws:

Exception

createPossibleDiscount

public void createPossibleDiscount(ShippingRule sr,
 ShippingRuleRange srr,
 OrderItem oi)
                            throws Exception

Throws:

Exception

createMethodLimit

public void createMethodLimit(ShippingRule sr,
 ShippingRuleRange srr,
 OrderItem oi)
                       throws Exception

Throws:

Exception

isShippingRuleOk

public boolean isShippingRuleOk(ShippingRule shippingRule,
 OrderItem oi)
                         throws Exception

Throws:

Exception

getShippingRulesBySkuIDs

public Collection getShippingRulesBySkuIDs(Collection skuIDs)
                                    throws Exception

Throws:

Exception

getSkuIDs

public Collection getSkuIDs(OrderItem oi,
 Collection matchingSkus)

processRemoveAllRules

public Map processRemoveAllRules()
                          throws Exception

Throws:

Exception