com.konakart.bl.modules.ordertotal.freeproduct

Class FreeProduct

java.lang.Object

com.konakart.bl.modules.BaseModule

com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

com.konakart.bl.modules.ordertotal.freeproduct.FreeProduct

All Implemented Interfaces:

OrderTotalInterface

public class FreeProduct
extends BaseOrderTotalModule
implements OrderTotalInterface

Module that creates an OrderTotal object for awarding a free product. The product to be awarded can have a status set to false so that it isn't enabled and cannot be searched for and bought normally through the store.

The SKU of the free product is saved in the Custom1 field of the Order Total. The id of the free product is saved in the Custom2 field of the Order Total.

The promotion may be activated only if:

• The total amount of the order is greater than a minimum amount
• The total number of products ordered is greater than a minimum amount
• The total number of a single product ordered is greater than a minimum amount

In order to enable inventory management for the free product, the promotion must be configured to disable the promotion if the product is out of stock and in the OrderIntegrationMgr you must uncomment the calls to manageFreeProductInventory().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FreeProduct.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
FreeProduct(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 free product.
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

FreeProduct

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

Constructor

Parameters:

eng - the KonaKart engine

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 free product.

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

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. In this case, since the result of the promotion isn't a discount but a product id, we convert the product id to a decimal and return it in the value attribute of the PromotionResult object.

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

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.