com.konakart.bl.modules.ordertotal

Interface OrderTotalInterface

All Known Implementing Classes:

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

public interface OrderTotalInterface

Interfaces to be implemented by Order Total Modules

Method Summary

Modifier and Type	Method and Description
void	commitOrder(OrderIf order) Commit the Order transaction.
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)
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.
int	getSortOrder()
boolean	isAvailable()
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.
void	setStaticVariables() Refreshes the static variables from the copy in the database

Method Detail

getOrderTotal

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

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

isAvailable

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

Returns:

True or False

Throws:

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

getSortOrder

int getSortOrder()

Returns:

Return the order in which the module gets called and displayed

getCode

java.lang.String getCode()

Returns:

Returns the code for the module

setStaticVariables

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

Refreshes the static variables from the copy in the database

Throws:

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

getOrderTotalList

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

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

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.

Parameters:

product - the product

promotion - the promotion

Returns:

Returns a PromotionResult object

Throws:

java.lang.Exception - an unexpected exception

commitOrder

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

Commit the Order transaction. Typically used to commit order transactions in tax service modules (such as Avalara).

Parameters:

order - the order

Throws:

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

getModuleClassName

java.lang.String getModuleClassName()

Gets the name of the module class.

Returns:

the module's class name.