com.konakart.bl.modules.ordertotal.tax

Class Tax

java.lang.Object

com.konakart.bl.modules.BaseModule

com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

com.konakart.bl.modules.ordertotal.tax.Tax

All Implemented Interfaces:

OrderTotalInterface

public class Tax
extends BaseOrderTotalModule
implements OrderTotalInterface

Module that creates an OrderTotal object for the amount of tax for the order.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Tax.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
Tax(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.
protected OrderTotal	getMultipleOT(Order order, Tax.StaticData sd, java.util.ResourceBundle rb) Display tax using an order total for each tax rate
protected KKCriteria	getNewCriteria(boolean allStores) Gets a new KKCriteria object with the option of it being for all stores when in multi-store single db mode.
protected void	getOrderCountryAndZone(Order order) Instantiate the Country and Zone objects for the order
OrderTotal	getOrderTotal(Order order, boolean dispPriceWithTax, java.util.Locale locale) Create and return an OrderTotal object for the tax amount.
protected OrderTotal	getSingleOT(Order order, Tax.StaticData sd, java.util.ResourceBundle rb) Display tax using a single order total
int	getSortOrder()
protected TaxRate[]	getTaxRateObjects(Order order, OrderProductIf op, int taxClassId)
boolean	isAvailable() Returns true or false
protected boolean	isMultiStoreShareCustomersOrProducts() Returns true if we need to share customers or products in multi-store single db mode
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, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getPromMgr, getRandomText, getRandomText, getResourceBundle, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getTaxMgr, getZoneCodeForZoneName, init, isAvailable, isAvailable, 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

Tax

public Tax(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 tax 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

getSingleOT

protected OrderTotal getSingleOT(Order order,
                                 Tax.StaticData sd,
                                 java.util.ResourceBundle rb)
                          throws java.lang.Exception

Display tax using a single order total

Parameters:

order - the order

sd - the sd

rb - the rb

Returns:

Returns a single Order Total

Throws:

java.lang.Exception - an unexpected exception

getMultipleOT

protected OrderTotal getMultipleOT(Order order,
                                   Tax.StaticData sd,
                                   java.util.ResourceBundle rb)
                            throws java.lang.Exception

Display tax using an order total for each tax rate

Parameters:

order - the order

sd - the sd

rb - the rb

Returns:

Returns an order total containing an array of order totals (one for each tax rate)

Throws:

java.lang.Exception - an unexpected exception

getTaxRateObjects

protected TaxRate[] getTaxRateObjects(Order order,
                                      OrderProductIf op,
                                      int taxClassId)
                               throws java.lang.Exception

Parameters:

order - the order

op - the op

taxClassId - the taxClassId

Returns:

Returns the tax rate objects for a tax class id, a country and a zone

Throws:

java.lang.Exception - an unexpected exception

getNewCriteria

protected KKCriteria getNewCriteria(boolean allStores)

Gets a new KKCriteria object with the option of it being for all stores when in multi-store single db mode.

Overrides:

getNewCriteria in class BaseModule

Parameters:

allStores - the allStores

Returns:

Returns a new KKCriteria object

isMultiStoreShareCustomersOrProducts

protected boolean isMultiStoreShareCustomersOrProducts()
                                                throws com.konakart.app.KKException

Returns true if we need to share customers or products in multi-store single db mode

Overrides:

isMultiStoreShareCustomersOrProducts in class BaseModule

Returns:

true if we're sharing customers or products

Throws:

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

getOrderCountryAndZone

protected void getOrderCountryAndZone(Order order)
                               throws java.lang.Exception

Instantiate the Country and Zone objects for the order

Parameters:

order - the order

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.