com.konakart.app

Class OrderTotal

java.lang.Object

com.konakart.app.OrderTotal

All Implemented Interfaces:

OrderTotalIf

public class OrderTotal
extends java.lang.Object
implements OrderTotalIf

Order Total Object

Constructor Summary

Constructors

Constructor and Description
OrderTotal() Constructor
OrderTotal(com.workingdogs.village.Record vr, KKCriteria c) Instantiates the attributes of the Language object from a Record object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassName() This is the name of the order total module.
OrderTotal	getClone() Creates a new clone OrderTotal object
java.lang.String	getCode()
java.lang.String	getCustom1()
java.lang.String	getCustom2()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
java.lang.String	getCustom5()
java.math.BigDecimal	getDiscountAmount() The discount amount defined by the promotion.
java.math.BigDecimal	getDiscountPercent() The discount percentage defined by the promotion.
int	getId()
int	getOrderId() The id of the order that the order total belongs to
OrderTotalIf[]	getOrderTotals() An array of OrderTotals which is populated if the OrderTotal module returns more than one result.
int	getPromotionId() The promotion id only when the order total contains the results of a promotion.
PromotionIf[]	getPromotions() An array to contain the promotion objects used to calculate the discount for a discount order total module.
int	getSortOrder() The sort order defines the order in which the order total items are added to the order.
java.math.BigDecimal	getTax() In some cases an OrderTotal can modify the tax calculated for an order.
java.math.BigDecimal	getTaxRate() The tax rate applicable for the order total
java.lang.String	getText() This is the actual text for the value of the order total.
java.lang.String	getTitle() This is the title for the order total which will appear on a print out of the order.
java.math.BigDecimal	getValue() The value is a numeric representation of the text which can be used to add the order totals in order to calculate the final total.
void	setClassName(java.lang.String className) This is the name of the order total module.
void	setCode(java.lang.String code)
void	setCustom1(java.lang.String custom1)
void	setCustom2(java.lang.String custom2)
void	setCustom3(java.lang.String custom3)
void	setCustom4(java.lang.String custom4)
void	setCustom5(java.lang.String custom5)
void	setDiscountAmount(java.math.BigDecimal discountAmount) The discount amount defined by the promotion.
void	setDiscountPercent(java.math.BigDecimal discountPercent) The discount percentage defined by the promotion.
void	setId(int id)
void	setOrderId(int orderId) The id of the order that the order total belongs to
void	setOrderTotals(OrderTotalIf[] orderTotals) An array of OrderTotals which is populated if the OrderTotal module returns more than one result.
void	setPromotionId(int promotionId) The promotion id only when the order total contains the results of a promotion.
void	setPromotions(PromotionIf[] promotions) An array to contain the promotion objects used to calculate the discount for a discount order total module.
void	setSortOrder(int sortOrder) The sort order defines the order in which the order total items are added to the order.
void	setTax(java.math.BigDecimal tax) In some cases an OrderTotal can modify the tax calculated for an order.
void	setTaxRate(java.math.BigDecimal taxRate) The tax rate applicable for the order total
void	setText(java.lang.String text) This is the actual text for the value of the order total.
void	setTitle(java.lang.String title) This is the title for the order total which will appear on a print out of the order.
void	setValue(java.math.BigDecimal value) The value is a numeric representation of the text which can be used to add the order totals in order to calculate the final total.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OrderTotal

public OrderTotal()

Constructor

OrderTotal

public OrderTotal(com.workingdogs.village.Record vr,
                  KKCriteria c)
           throws com.workingdogs.village.DataSetException

Instantiates the attributes of the Language object from a Record object

Parameters:

vr - Record containing data

c - Criteria containing column names

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

Method Detail

getClone

public OrderTotal getClone()

Creates a new clone OrderTotal object

Returns:

Returns an OrderTotal object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the OrderTotal object.

getClassName

public java.lang.String getClassName()

Description copied from interface: OrderTotalIf

This is the name of the order total module. e.g. ot_shipping, ot_tax, ot_total

Specified by:

getClassName in interface OrderTotalIf

Returns:

Returns the className.

setClassName

public void setClassName(java.lang.String className)

Description copied from interface: OrderTotalIf

This is the name of the order total module. e.g. ot_shipping, ot_tax, ot_total

Specified by:

setClassName in interface OrderTotalIf

Parameters:

className - The className to set.

getId

public int getId()

Specified by:

getId in interface OrderTotalIf

Returns:

Returns the id.

setId

public void setId(int id)

Specified by:

setId in interface OrderTotalIf

Parameters:

id - The id to set.

getOrderId

public int getOrderId()

Description copied from interface: OrderTotalIf

The id of the order that the order total belongs to

Specified by:

getOrderId in interface OrderTotalIf

Returns:

Returns the orderId.

setOrderId

public void setOrderId(int orderId)

Description copied from interface: OrderTotalIf

The id of the order that the order total belongs to

Specified by:

setOrderId in interface OrderTotalIf

Parameters:

orderId - The orderId to set.

getSortOrder

public int getSortOrder()

Description copied from interface: OrderTotalIf

The sort order defines the order in which the order total items are added to the order. ot_total should be last since it adds up all of the other order totals to calculate the total of the order.

Specified by:

getSortOrder in interface OrderTotalIf

Returns:

Returns the sortOrder.

setSortOrder

public void setSortOrder(int sortOrder)

Description copied from interface: OrderTotalIf

The sort order defines the order in which the order total items are added to the order. ot_total should be last since it adds up all of the other order totals to calculate the total of the order.

Specified by:

setSortOrder in interface OrderTotalIf

Parameters:

sortOrder - The sortOrder to set.

getText

public java.lang.String getText()

Description copied from interface: OrderTotalIf

This is the actual text for the value of the order total. e.g. $95.00 or $90.00

Specified by:

getText in interface OrderTotalIf

Returns:

Returns the text.

setText

public void setText(java.lang.String text)

Description copied from interface: OrderTotalIf

This is the actual text for the value of the order total. e.g. $95.00 or $90.00

Specified by:

setText in interface OrderTotalIf

Parameters:

text - The text to set.

getTitle

public java.lang.String getTitle()

Description copied from interface: OrderTotalIf

This is the title for the order total which will appear on a print out of the order. e.g. Sub-Total: or Total:

Specified by:

getTitle in interface OrderTotalIf

Returns:

Returns the title.

setTitle

public void setTitle(java.lang.String title)

Description copied from interface: OrderTotalIf

This is the title for the order total which will appear on a print out of the order. e.g. Sub-Total: or Total:

Specified by:

setTitle in interface OrderTotalIf

Parameters:

title - The title to set.

getValue

public java.math.BigDecimal getValue()

Description copied from interface: OrderTotalIf

The value is a numeric representation of the text which can be used to add the order totals in order to calculate the final total.

Specified by:

getValue in interface OrderTotalIf

Returns:

Returns the value.

setValue

public void setValue(java.math.BigDecimal value)

Description copied from interface: OrderTotalIf

The value is a numeric representation of the text which can be used to add the order totals in order to calculate the final total.

Specified by:

setValue in interface OrderTotalIf

Parameters:

value - The value to set.

getPromotions

public PromotionIf[] getPromotions()

Description copied from interface: OrderTotalIf

An array to contain the promotion objects used to calculate the discount for a discount order total module.

Specified by:

getPromotions in interface OrderTotalIf

Returns:

Returns the promotions.

setPromotions

public void setPromotions(PromotionIf[] promotions)

Description copied from interface: OrderTotalIf

An array to contain the promotion objects used to calculate the discount for a discount order total module.

Specified by:

setPromotions in interface OrderTotalIf

Parameters:

promotions - The promotions to set.

getOrderTotals

public OrderTotalIf[] getOrderTotals()

Description copied from interface: OrderTotalIf

An array of OrderTotals which is populated if the OrderTotal module returns more than one result.

Specified by:

getOrderTotals in interface OrderTotalIf

Returns:

the orderTotals

setOrderTotals

public void setOrderTotals(OrderTotalIf[] orderTotals)

Description copied from interface: OrderTotalIf

An array of OrderTotals which is populated if the OrderTotal module returns more than one result.

Specified by:

setOrderTotals in interface OrderTotalIf

Parameters:

orderTotals - the orderTotals to set

getCustom1

public java.lang.String getCustom1()

Specified by:

getCustom1 in interface OrderTotalIf

Returns:

the custom1

setCustom1

public void setCustom1(java.lang.String custom1)

Specified by:

setCustom1 in interface OrderTotalIf

Parameters:

custom1 - the custom1 to set

getCustom2

public java.lang.String getCustom2()

Specified by:

getCustom2 in interface OrderTotalIf

Returns:

the custom2

setCustom2

public void setCustom2(java.lang.String custom2)

Specified by:

setCustom2 in interface OrderTotalIf

Parameters:

custom2 - the custom2 to set

getCustom3

public java.lang.String getCustom3()

Specified by:

getCustom3 in interface OrderTotalIf

Returns:

the custom3

setCustom3

public void setCustom3(java.lang.String custom3)

Specified by:

setCustom3 in interface OrderTotalIf

Parameters:

custom3 - the custom3 to set

getTax

public java.math.BigDecimal getTax()

Description copied from interface: OrderTotalIf

In some cases an OrderTotal can modify the tax calculated for an order. This is the case when a promotion is applied to the total of the order before tax. In this case the amount of tax for the order needs to be reduced since it is calculated on the total of the order minus the discount.

Specified by:

getTax in interface OrderTotalIf

Returns:

the tax

setTax

public void setTax(java.math.BigDecimal tax)

Description copied from interface: OrderTotalIf

In some cases an OrderTotal can modify the tax calculated for an order. This is the case when a promotion is applied to the total of the order before tax. In this case the amount of tax for the order needs to be reduced since it is calculated on the total of the order minus the discount.

Specified by:

setTax in interface OrderTotalIf

Parameters:

tax - the tax to set

getCustom4

public java.lang.String getCustom4()

Specified by:

getCustom4 in interface OrderTotalIf

Returns:

the custom4

setCustom4

public void setCustom4(java.lang.String custom4)

Specified by:

setCustom4 in interface OrderTotalIf

Parameters:

custom4 - the custom4 to set

getCustom5

public java.lang.String getCustom5()

Specified by:

getCustom5 in interface OrderTotalIf

Returns:

the custom5

setCustom5

public void setCustom5(java.lang.String custom5)

Specified by:

setCustom5 in interface OrderTotalIf

Parameters:

custom5 - the custom5 to set

getPromotionId

public int getPromotionId()

Description copied from interface: OrderTotalIf

The promotion id only when the order total contains the results of a promotion. Defaults to 0.

Specified by:

getPromotionId in interface OrderTotalIf

Returns:

the promotionId

setPromotionId

public void setPromotionId(int promotionId)

Description copied from interface: OrderTotalIf

The promotion id only when the order total contains the results of a promotion. Defaults to 0.

Specified by:

setPromotionId in interface OrderTotalIf

Parameters:

promotionId - the promotionId to set

getDiscountAmount

public java.math.BigDecimal getDiscountAmount()

Description copied from interface: OrderTotalIf

The discount amount defined by the promotion. This will be null unless the order total contains the results of a promotion and the promotion defines a discount amount rather than a discount percentage.

Specified by:

getDiscountAmount in interface OrderTotalIf

Returns:

the discountAmount

setDiscountAmount

public void setDiscountAmount(java.math.BigDecimal discountAmount)

Description copied from interface: OrderTotalIf

The discount amount defined by the promotion. This will be null unless the order total contains the results of a promotion and the promotion defines a discount amount rather than a discount percentage.

Specified by:

setDiscountAmount in interface OrderTotalIf

Parameters:

discountAmount - the discountAmount to set

getDiscountPercent

public java.math.BigDecimal getDiscountPercent()

Description copied from interface: OrderTotalIf

The discount percentage defined by the promotion. This will be null unless the order total contains the results of a promotion and the promotion defines a discount percentage rather than a discount amount.

Specified by:

getDiscountPercent in interface OrderTotalIf

Returns:

the discountPercent

setDiscountPercent

public void setDiscountPercent(java.math.BigDecimal discountPercent)

Description copied from interface: OrderTotalIf

The discount percentage defined by the promotion. This will be null unless the order total contains the results of a promotion and the promotion defines a discount percentage rather than a discount amount.

Specified by:

setDiscountPercent in interface OrderTotalIf

Parameters:

discountPercent - the discountPercent to set

getTaxRate

public java.math.BigDecimal getTaxRate()

Description copied from interface: OrderTotalIf

The tax rate applicable for the order total

Specified by:

getTaxRate in interface OrderTotalIf

Returns:

the taxRate

setTaxRate

public void setTaxRate(java.math.BigDecimal taxRate)

Description copied from interface: OrderTotalIf

The tax rate applicable for the order total

Specified by:

setTaxRate in interface OrderTotalIf

Parameters:

taxRate - the taxRate to set

getCode

public java.lang.String getCode()

Specified by:

getCode in interface OrderTotalIf

Returns:

the code

setCode

public void setCode(java.lang.String code)

Specified by:

setCode in interface OrderTotalIf

Parameters:

code - the code to set