com.konakart.bl.modules.ordertotal.buyxgetyfree

Class BuyXGetYFree

java.lang.Object

com.konakart.bl.modules.BaseModule

com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

com.konakart.bl.modules.ordertotal.buyxgetyfree.BuyXGetYFree

All Implemented Interfaces:

OrderTotalInterface

public class BuyXGetYFree
extends BaseOrderTotalModule
implements OrderTotalInterface

Module that creates an OrderTotal object for applying a Buy X Get Y Free discount. The discount may be applied on prices before or after tax. The promotion may be activated on a product only if:

• The total amount of the order is greater than a minimum amount

There may be multiple valid promotions applicable for an order. If this is the case, the logic applied is the following: All cumulative promotions are summed into one order total object. Then we loop through the order total objects and choose the one that offers the largest discount.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BuyXGetYFree.StaticData Used to store the static data of this module

Field Summary

Fields inherited from class com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

log, orderTotalList

Fields inherited from class com.konakart.bl.modules.BaseModule

basePackage, debugStackTraceExclusions

Constructor Summary

Constructors

Constructor and Description
BuyXGetYFree(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode()
java.lang.String	getModuleClassName() Gets the name of the module class.
OrderTotal	getOrderTotal(Order order, boolean dispPriceWithTax, java.util.Locale locale) Create and return an OrderTotal object for the discount amount.
PromotionResult	getPromotionResult(Product product, Promotion promotion) Returns an object containing the promotion discount.
int	getSortOrder()
boolean	isAvailable() Returns true or false
void	setStaticVariables() Sets some static variables during setup

Methods inherited from class com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

addTax, commitOrder, getCustomBigDecimal, getCustomBoolean, getCustomInt, getCustomString, getDiscountOrderTotalFromList, getDiscountOrderTotalFromList, getOrderTotalList, getTaxForDiscount, getTaxFromTotal, removeCouponId, removePromotionId, removeTax, setCouponIds, setOrderTotalList, setPromotionIds, setRefundValues, setRefundValuesForSingleOrderTotal

Methods inherited from class com.konakart.bl.modules.BaseModule

getBasketMgr, getCatMgr, getConfigMgr, getConfiguration, getConfigurationValue, getConfigurationValueAsBigDecimalWithDefault, getConfigurationValueAsBool, getConfigurationValueAsIntWithDefault, getCurrMgr, getCustMgr, getCustTagMgr, getDebugStackTraceExclusions, getEmailMgr, getEng, getLangMgr, getMultiStoreMgr, getNewCriteria, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getPromMgr, getRandomText, getRandomText, getResourceBundle, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getTaxMgr, getZoneCodeForZoneName, init, isAvailable, isAvailable, isMultiStoreShareCustomersOrProducts, setDebugStackTraceExclusions, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.konakart.bl.modules.ordertotal.OrderTotalInterface

commitOrder, getOrderTotalList, setOrderTotalList

Constructor Detail

BuyXGetYFree

public BuyXGetYFree(KKEngIf eng)
             throws org.apache.torque.TorqueException,
                    com.konakart.app.KKException,
                    com.workingdogs.village.DataSetException

Constructor

Parameters:

eng - the eng

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

Method Detail

setStaticVariables

public void setStaticVariables()
                        throws com.konakart.app.KKException

Sets some static variables during setup

Specified by:

setStaticVariables in interface OrderTotalInterface

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

isAvailable

public boolean isAvailable()
                    throws com.konakart.app.KKException

Returns true or false

Specified by:

isAvailable in interface OrderTotalInterface

Returns:

True or False

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getOrderTotal

public OrderTotal getOrderTotal(Order order,
                                boolean dispPriceWithTax,
                                java.util.Locale locale)
                         throws java.lang.Exception

Create and return an OrderTotal object for the discount amount.

Custom field usage:

• custom2 = Buy Quantity
• custom3 = Free Quantity
• custom1 = Minimum Order Value
• custom4 = Apply discount before tax

If the promotion applies to multiple products, we create an array of order total objects and attach the array to the order total that we return (ot.setOrderTotals(otArray)). The reason for doing this is to get a line item of the order for each discounted product. We still need to populate the order total that we return with the total discount amount because this will be used to compare this promotion with other promotions in order to decide which one to use.

The returned OrderTotal custom attributes are populated as follows:

• custom1 = Product Id
• custom2 = Product SKU
• custom3 = Encoded Product Id containing the product id and ids of the options.

Specified by:

getOrderTotal in interface OrderTotalInterface

Parameters:

order - the order

dispPriceWithTax - the dispPriceWithTax

locale - the locale

Returns:

Returns an OrderTotal object for this module

Throws:

java.lang.Exception - an unexpected exception

getSortOrder

public int getSortOrder()

Specified by:

getSortOrder in interface OrderTotalInterface

Returns:

Return the order in which the module gets called and displayed

getCode

public java.lang.String getCode()

Specified by:

getCode in interface OrderTotalInterface

Returns:

Returns the code for the module

getModuleClassName

public java.lang.String getModuleClassName()

Description copied from class: BaseModule

Gets the name of the module class.

Specified by:

getModuleClassName in interface OrderTotalInterface

Overrides:

getModuleClassName in class BaseModule

Returns:

the module's class name.

getPromotionResult

public PromotionResult getPromotionResult(Product product,
                                          Promotion promotion)
                                   throws java.lang.Exception

Returns an object containing the promotion discount. This method is used to apply the promotion to a single product.

Specified by:

getPromotionResult in interface OrderTotalInterface

Overrides:

getPromotionResult in class BaseOrderTotalModule

Parameters:

product - the product

promotion - the promotion

Returns:

Returns a PromotionResult object

Throws:

java.lang.Exception - an unexpected exception