OrderTotalIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

OrderTotal
```
public interface OrderTotalIf
```
An order may have an array of OrderTotal objects. Each OrderTotal object is created by an OrderTotal module. Modules may be enabled / disabled using the Admin App so that you can decide whether your order shows tax, shipping charges, subtotal, discount etc.
There is an API call getOrderTotals() which is used to populate the order with an array of order totals.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getClassName()` This is the name of the order total module.
`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.

- Method Detail
  - getClassName
```
java.lang.String getClassName()
```
    This is the name of the order total module. e.g. ot_shipping, ot_tax, ot_total
    
    Returns:
    
    Returns the className.
  - setClassName
```
void setClassName(java.lang.String className)
```
    This is the name of the order total module. e.g. ot_shipping, ot_tax, ot_total
    
    Parameters:
    
    className - The className to set.
  - getId
```
int getId()
```
    Returns:
    
    Returns the id.
  - setId
```
void setId(int id)
```
    Parameters:
    
    id - The id to set.
  - getOrderId
```
int getOrderId()
```
    The id of the order that the order total belongs to
    
    Returns:
    
    Returns the orderId.
  - setOrderId
```
void setOrderId(int orderId)
```
    The id of the order that the order total belongs to
    
    Parameters:
    
    orderId - The orderId to set.
  - getSortOrder
```
int getSortOrder()
```
    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.
    
    Returns:
    
    Returns the sortOrder.
  - setSortOrder
```
void setSortOrder(int sortOrder)
```
    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.
    
    Parameters:
    
    sortOrder - The sortOrder to set.
  - getText
```
java.lang.String getText()
```
    This is the actual text for the value of the order total. e.g. $95.00 or $90.00
    
    Returns:
    
    Returns the text.
  - setText
```
void setText(java.lang.String text)
```
    This is the actual text for the value of the order total. e.g. $95.00 or $90.00
    
    Parameters:
    
    text - The text to set.
  - getTitle
```
java.lang.String getTitle()
```
    This is the title for the order total which will appear on a print out of the order. e.g. Sub-Total: or Total:
    
    Returns:
    
    Returns the title.
  - setTitle
```
void setTitle(java.lang.String title)
```
    This is the title for the order total which will appear on a print out of the order. e.g. Sub-Total: or Total:
    
    Parameters:
    
    title - The title to set.
  - getValue
```
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.
    
    Returns:
    
    Returns the value.
  - setValue
```
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.
    
    Parameters:
    
    value - The value to set.
  - getTax
```
java.math.BigDecimal getTax()
```
    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.
    
    Returns:
    
    the tax
  - setTax
```
void setTax(java.math.BigDecimal tax)
```
    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.
    
    Parameters:
    
    tax - the tax to set
  - getTaxRate
```
java.math.BigDecimal getTaxRate()
```
    The tax rate applicable for the order total
    
    Returns:
    
    the taxRate
  - setTaxRate
```
void setTaxRate(java.math.BigDecimal taxRate)
```
    The tax rate applicable for the order total
    
    Parameters:
    
    taxRate - the taxRate to set
  - getPromotionId
```
int getPromotionId()
```
    The promotion id only when the order total contains the results of a promotion. Defaults to 0.
    
    Returns:
    
    the promotionId
  - setPromotionId
```
void setPromotionId(int promotionId)
```
    The promotion id only when the order total contains the results of a promotion. Defaults to 0.
    
    Parameters:
    
    promotionId - the promotionId to set
  - getDiscountAmount
```
java.math.BigDecimal getDiscountAmount()
```
    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.
    
    Returns:
    
    the discountAmount
  - setDiscountAmount
```
void setDiscountAmount(java.math.BigDecimal discountAmount)
```
    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.
    
    Parameters:
    
    discountAmount - the discountAmount to set
  - getDiscountPercent
```
java.math.BigDecimal getDiscountPercent()
```
    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.
    
    Returns:
    
    the discountPercent
  - setDiscountPercent
```
void setDiscountPercent(java.math.BigDecimal discountPercent)
```
    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.
    
    Parameters:
    
    discountPercent - the discountPercent to set
  - getPromotions
```
PromotionIf[] getPromotions()
```
    An array to contain the promotion objects used to calculate the discount for a discount order total module.
    
    Returns:
    
    Returns the promotions.
  - setPromotions
```
void setPromotions(PromotionIf[] promotions)
```
    An array to contain the promotion objects used to calculate the discount for a discount order total module.
    
    Parameters:
    
    promotions - The promotions to set.
  - getOrderTotals
```
OrderTotalIf[] getOrderTotals()
```
    An array of OrderTotals which is populated if the OrderTotal module returns more than one result.
    
    Returns:
    
    the orderTotals
  - setOrderTotals
```
void setOrderTotals(OrderTotalIf[] orderTotals)
```
    An array of OrderTotals which is populated if the OrderTotal module returns more than one result.
    
    Parameters:
    
    orderTotals - the orderTotals to set
  - getCustom1
```
java.lang.String getCustom1()
```
    Returns:
    
    the custom1
  - setCustom1
```
void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
java.lang.String getCustom2()
```
    Returns:
    
    the custom2
  - setCustom2
```
void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom3
```
java.lang.String getCustom3()
```
    Returns:
    
    the custom3
  - setCustom3
```
void setCustom3(java.lang.String custom3)
```
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom4
```
java.lang.String getCustom4()
```
    Returns:
    
    the custom4
  - setCustom4
```
void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - the custom4 to set
  - getCustom5
```
java.lang.String getCustom5()
```
    Returns:
    
    the custom5
  - setCustom5
```
void setCustom5(java.lang.String custom5)
```
    Parameters:
    
    custom5 - the custom5 to set
  - getCode
```
java.lang.String getCode()
```
    Returns:
    
    the code
  - setCode
```
void setCode(java.lang.String code)
```
    Parameters:
    
    code - the code to set

Interface OrderTotalIf

Method Summary

Method Detail

getClassName

setClassName

getId

setId

getOrderId

setOrderId

getSortOrder

setSortOrder

getText

setText

getTitle

setTitle

getValue

setValue

getTax

setTax

getTaxRate

setTaxRate

getPromotionId

setPromotionId

getDiscountAmount

setDiscountAmount

getDiscountPercent

setDiscountPercent

getPromotions

setPromotions

getOrderTotals

setOrderTotals

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

getCode

setCode