com.konakart.bl.modules.ordertotal

Class BaseOrderTotalModule

java.lang.Object

com.konakart.bl.modules.BaseModule

com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

Direct Known Subclasses:

BuyXGetYFree, ExternalTax, FreeProduct, GiftCertificate, PaymentCharge, ProductDiscount, ProductRewardPoints, RedeemPoints, RewardPoints, Shipping, ShippingDiscount, Subtotal, Tax, TaxCloud, Total, TotalDiscount, TotalDiscountAdmin

public class BaseOrderTotalModule
extends BaseModule

Base Order Total Module

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log The Log instance for this application.
protected java.util.List<OrderTotal>	orderTotalList A list of the current order totals so that an order total module can modify an order total that was previously called.

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

basePackage, debugStackTraceExclusions

Constructor Summary

Constructors

Constructor and Description
BaseOrderTotalModule()

Method Summary

Modifier and Type	Method and Description
protected java.math.BigDecimal	addTax(java.math.BigDecimal value, java.math.BigDecimal taxRate, int scale) Utility method to add tax to a value
void	commitOrder(OrderIf order) Commit the Order transaction.
protected java.math.BigDecimal	getCustomBigDecimal(java.lang.String customAttr, int customId) Utility method that gets a BigDecimal from one of the promotion custom attributes
protected boolean	getCustomBoolean(java.lang.String customAttr, int customId) Utility method that gets a boolean from one of the promotion custom attributes
protected int	getCustomInt(java.lang.String customAttr, int customId) Utility method that gets an int from one of the promotion custom attributes
protected java.lang.String	getCustomString(java.lang.String customAttr, int customId) Utility method that gets a String from one of the promotion custom attributes.
protected OrderTotal	getDiscountOrderTotalFromList(Order order, java.util.List<OrderTotal> orderTotalsList) This is a helper method for the discount modules.
protected OrderTotal	getDiscountOrderTotalFromList(Order order, java.util.List<OrderTotal> orderTotalsList, boolean applyBeforeTax) This is a helper method for the discount modules.
java.util.List<OrderTotal>	getOrderTotalList() A list of the current order totals so that an order total module can modify an order total that was previously called.
PromotionResult	getPromotionResult(Product product, Promotion promotion) Returns an object containing the promotion discount
java.math.BigDecimal	getTaxForDiscount(Order order, java.math.BigDecimal discount, int scale, boolean applyBeforeTax) Method used to calculate the tax portion of a discount based on the average tax rate of the order which needs to be calculated.
java.math.BigDecimal	getTaxFromTotal(java.math.BigDecimal total, java.math.BigDecimal taxRate, int scale) The total is the total value including tax.
protected void	removeCouponId(Order order, java.lang.String couponId) Removes the coupon id from an order if it exists
protected void	removePromotionId(Order order, java.lang.String promotionId) Removes the promotion id from an order if it exists
protected java.math.BigDecimal	removeTax(java.math.BigDecimal value, java.math.BigDecimal taxRate, int scale) Utility method to remove tax from a value
protected void	setCouponIds(Order order, java.lang.String couponIds) Sets the coupon ids of an order taking care not to overwrite the existing ones
void	setOrderTotalList(java.util.List<OrderTotal> orderTotalList) A list of the current order totals so that an order total module can modify an order total that was previously called.
protected void	setPromotionIds(Order order, java.lang.String promotionIds) Sets the promotion ids of an order taking care not to overwrite the existing ones
protected void	setRefundValues(Order order, OrderTotal ot, boolean applyBeforeTax) Modifies the refund values on the order total objects based on the promotion.
protected void	setRefundValuesForSingleOrderTotal(Order order, OrderTotal ot, boolean applyBeforeTax, int scale) Modifies the refund values on a single order total object based on the promotion.

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

getBasketMgr, getCatMgr, getConfigMgr, getConfiguration, getConfigurationValue, getConfigurationValueAsBigDecimalWithDefault, getConfigurationValueAsBool, getConfigurationValueAsIntWithDefault, getCurrMgr, getCustMgr, getCustTagMgr, getDebugStackTraceExclusions, getEmailMgr, getEng, getLangMgr, getModuleClassName, 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

Field Detail

log

protected org.apache.commons.logging.Log log

The Log instance for this application.

orderTotalList

protected java.util.List<OrderTotal> orderTotalList

A list of the current order totals so that an order total module can modify an order total that was previously called.

Constructor Detail

BaseOrderTotalModule

public BaseOrderTotalModule()

Method Detail

getCustomInt

protected int getCustomInt(java.lang.String customAttr,
                           int customId)
                    throws com.konakart.app.KKException

Utility method that gets an int from one of the promotion custom attributes

Parameters:

customAttr - the customAttr

customId - the customId

Returns:

int

Throws:

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

getCustomBigDecimal

protected java.math.BigDecimal getCustomBigDecimal(java.lang.String customAttr,
                                                   int customId)
                                            throws com.konakart.app.KKException

Utility method that gets a BigDecimal from one of the promotion custom attributes

Parameters:

customAttr - the customAttr

customId - the customId

Returns:

BigDecimal

Throws:

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

getCustomBoolean

protected boolean getCustomBoolean(java.lang.String customAttr,
                                   int customId)
                            throws com.konakart.app.KKException

Utility method that gets a boolean from one of the promotion custom attributes

Parameters:

customAttr - the customAttr

customId - the customId

Returns:

boolean

Throws:

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

getCustomString

protected java.lang.String getCustomString(java.lang.String customAttr,
                                           int customId)
                                    throws com.konakart.app.KKException

Utility method that gets a String from one of the promotion custom attributes. It ensures that the value isn't null.

Parameters:

customAttr - the customAttr

customId - the customId

Returns:

String

Throws:

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

getDiscountOrderTotalFromList

protected OrderTotal getDiscountOrderTotalFromList(Order order,
                                                   java.util.List<OrderTotal> orderTotalsList)
                                            throws java.lang.Exception

This is a helper method for the discount modules. Many promotions may be relevant for an order. This method receives all of the relative promotions (in the form of Order Total objects) in a list as an input parameter. It sums all of the cumulative promotions into a single Order Total object and then compares all of the order totals that it has, in order to select the one that provides the largest discount.

Parameters:

order - the order

orderTotalsList - the orderTotalsList

Returns:

An OrderTotal object

Throws:

java.lang.Exception - an unexpected exception

getDiscountOrderTotalFromList

protected OrderTotal getDiscountOrderTotalFromList(Order order,
                                                   java.util.List<OrderTotal> orderTotalsList,
                                                   boolean applyBeforeTax)
                                            throws java.lang.Exception

This is a helper method for the discount modules. Many promotions may be relevant for an order. This method receives all of the relative promotions (in the form of Order Total objects) in a list as an input parameter. It sums all of the cumulative promotions into a single Order Total object and then compares all of the order totals that it has, in order to select the one that provides the largest discount.

Parameters:

order - the order

orderTotalsList - the orderTotalsList

applyBeforeTax - True when the discount is applied to total before tax is calculated. false when the discount is applied to the total including tax.

Returns:

An OrderTotal object

Throws:

java.lang.Exception - an unexpected exception

setRefundValues

protected void setRefundValues(Order order,
                               OrderTotal ot,
                               boolean applyBeforeTax)
                        throws java.lang.Exception

Modifies the refund values on the order total objects based on the promotion. Currently the promotions covered are:

• ot_product_discount
• ot_buy_x_get_y_free
• ot_total_discount

Note that the source code of this calculation is available because this is a tricky area especially when multiple promotions are active, so it's possible that you may want to tweak the calculations to match your desired result.

Note also that the reward point values are not modified.

Parameters:

order - the order

ot - the ot

applyBeforeTax - the applyBeforeTax

Throws:

java.lang.Exception - an unexpected exception

setRefundValuesForSingleOrderTotal

protected void setRefundValuesForSingleOrderTotal(Order order,
                                                  OrderTotal ot,
                                                  boolean applyBeforeTax,
                                                  int scale)
                                           throws java.lang.Exception

Modifies the refund values on a single order total object based on the promotion. Called by setRefundValues().

Parameters:

order - the order

ot - the ot

applyBeforeTax - the applyBeforeTax

scale - the scale

Throws:

java.lang.Exception - an unexpected exception

removeTax

protected java.math.BigDecimal removeTax(java.math.BigDecimal value,
                                         java.math.BigDecimal taxRate,
                                         int scale)

Utility method to remove tax from a value

Parameters:

value - the value

taxRate - the taxRate

scale - the scale

Returns:

Returns the value with the tax removed

addTax

protected java.math.BigDecimal addTax(java.math.BigDecimal value,
                                      java.math.BigDecimal taxRate,
                                      int scale)

Utility method to add tax to a value

Parameters:

value - the value

taxRate - the taxRate

scale - the scale

Returns:

Returns the value with the added tax

setPromotionIds

protected void setPromotionIds(Order order,
                               java.lang.String promotionIds)

Sets the promotion ids of an order taking care not to overwrite the existing ones

Parameters:

order - the order

promotionIds - the promotionIds

setCouponIds

protected void setCouponIds(Order order,
                            java.lang.String couponIds)

Sets the coupon ids of an order taking care not to overwrite the existing ones

Parameters:

order - the order

couponIds - the couponIds

removeCouponId

protected void removeCouponId(Order order,
                              java.lang.String couponId)

Removes the coupon id from an order if it exists

Parameters:

order - the order

couponId - the couponId

removePromotionId

protected void removePromotionId(Order order,
                                 java.lang.String promotionId)

Removes the promotion id from an order if it exists

Parameters:

order - the order

promotionId - the promotionId

getOrderTotalList

public java.util.List<OrderTotal> getOrderTotalList()

A list of the current order totals so that an order total module can modify an order total that was previously called.

Returns:

the orderTotalList

setOrderTotalList

public void setOrderTotalList(java.util.List<OrderTotal> orderTotalList)

A list of the current order totals so that an order total module can modify an order total that was previously called.

Parameters:

orderTotalList - the orderTotalList to set

getPromotionResult

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

Returns an object containing the promotion discount

Parameters:

product - the product

promotion - the promotion

Returns:

Returns a PromotionResult object

Throws:

java.lang.Exception - an unexpected exception

commitOrder

public void commitOrder(OrderIf order)
                 throws java.lang.Exception

Commit the Order transaction. Default implementation does nothing. Typically implemented in a tax service Order Total module such as Avalara.

Parameters:

order - the order

Throws:

java.lang.Exception - an unexpected exception if something unexpected happens

getTaxFromTotal

public java.math.BigDecimal getTaxFromTotal(java.math.BigDecimal total,
                                            java.math.BigDecimal taxRate,
                                            int scale)

The total is the total value including tax. The tax rate is the rate / 100 so 10% would be 0.1.

If the total = 10 and the tax rate = 0.1 then the method would return 0.9091 because in this case the total of 10 is equivalent to 9.0909 + 0.9091 = 10 .

The value returned is (total x taxRate) / (1 + taxRate)

Parameters:

total - the total

taxRate - the taxRate

scale - the scale

Returns:

Returns the tax part of the total

getTaxForDiscount

public java.math.BigDecimal getTaxForDiscount(Order order,
                                              java.math.BigDecimal discount,
                                              int scale,
                                              boolean applyBeforeTax)

Method used to calculate the tax portion of a discount based on the average tax rate of the order which needs to be calculated. Typically used to reduce the tax portion for an order when a global discount is applied such as a percentage discount on the order total.

Parameters:

order - the order

discount - the discount

scale - the scale

applyBeforeTax - the applyBeforeTax

Returns:

Returns the tax