com.konakart.bl.modules.ordertotal.totaldiscountadmin

Class TotalDiscountAdmin

java.lang.Object

com.konakart.bl.modules.BaseModule

com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

com.konakart.bl.modules.ordertotal.totaldiscountadmin.TotalDiscountAdmin

All Implemented Interfaces:

OrderTotalInterface

public class TotalDiscountAdmin
extends BaseOrderTotalModule
implements OrderTotalInterface

Module that creates an OrderTotal object for applying a percentage discount or an amount discount on the order. The discount may be applied on the total value of the order before or after tax. 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

The discount is entered by an administrator when editing the order, rather than being defined when the order is created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TotalDiscountAdmin.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
TotalDiscountAdmin(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.
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, getPromotionResult, 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, getPromotionResult, setOrderTotalList

Constructor Detail

TotalDiscountAdmin

public TotalDiscountAdmin(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.

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.