AdminOrderTotal (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.app.AdminOrderTotal

public class AdminOrderTotal
extends java.lang.Object

CustomerSearch object for the Admin App

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`className` class
`private java.lang.String`	`code` code
`private java.lang.String`	`custom1` Custom fields
`private java.lang.String`	`custom2`
`private java.lang.String`	`custom3`
`private java.lang.String`	`custom4`
`private java.lang.String`	`custom5`
`private java.math.BigDecimal`	`discountAmount` discountAmount
`private java.math.BigDecimal`	`discountPercent` discountPercent
`private int`	`id` id
`private int`	`orderId` orderId
`private int`	`promotionId` promotionId
`private int`	`sortOrder` sortOrder
`private java.math.BigDecimal`	`taxRate` Tax rate associated with OrderTotal
`private java.lang.String`	`text` text
`private java.lang.String`	`title` title
`private java.math.BigDecimal`	`value` value

Constructor Summary

Constructors
Constructor and Description
`AdminOrderTotal()` Constructor
`AdminOrderTotal(com.workingdogs.village.Record vr, com.konakart.db.KKCriteria c)` Instantiates the attributes of the Language object from a Record object

Method Summary

All Methods Instance Methods Concrete 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
`int`	`getPromotionId()` The promotion id only when the order total contains the results of a promotion.
`int`	`getSortOrder()` The sort order defines the order in which the order total items are added to the order.
`java.math.BigDecimal`	`getTaxRate()`
`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`	`setPromotionId(int promotionId)` The promotion id only when the order total contains the results of a promotion.
`void`	`setSortOrder(int sortOrder)` The sort order defines the order in which the order total items are added to the order.
`void`	`setTaxRate(java.math.BigDecimal taxRate)`
`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

- Field Detail
  - id
```
private int id
```
    id
  - orderId
```
private int orderId
```
    orderId
  - promotionId
```
private int promotionId
```
    promotionId
  - title
```
private java.lang.String title
```
    title
  - text
```
private java.lang.String text
```
    text
  - code
```
private java.lang.String code
```
    code
  - value
```
private java.math.BigDecimal value
```
    value
  - taxRate
```
private java.math.BigDecimal taxRate
```
    Tax rate associated with OrderTotal
  - discountAmount
```
private java.math.BigDecimal discountAmount
```
    discountAmount
  - discountPercent
```
private java.math.BigDecimal discountPercent
```
    discountPercent
  - className
```
private java.lang.String className
```
    class
  - sortOrder
```
private int sortOrder
```
    sortOrder
  - custom1
```
private java.lang.String custom1
```
    Custom fields
  - custom2
```
private java.lang.String custom2
```
  - custom3
```
private java.lang.String custom3
```
  - custom4
```
private java.lang.String custom4
```
  - custom5
```
private java.lang.String custom5
```
- Constructor Detail
  - AdminOrderTotal
```
public AdminOrderTotal()
```
    Constructor
  - AdminOrderTotal
```
public AdminOrderTotal(com.workingdogs.village.Record vr,
                       com.konakart.db.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
  - 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()
```
    This is the name of the order total module. e.g. ot_shipping, ot_tax, ot_total
    
    Returns:
    
    Returns the className.
  - setClassName
```
public 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
```
public int getId()
```
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - The id to set.
  - getOrderId
```
public int getOrderId()
```
    The id of the order that the order total belongs to
    
    Returns:
    
    Returns the orderId.
  - setOrderId
```
public void setOrderId(int orderId)
```
    The id of the order that the order total belongs to
    
    Parameters:
    
    orderId - The orderId to set.
  - getSortOrder
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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.
  - getPromotionId
```
public int getPromotionId()
```
    The promotion id only when the order total contains the results of a promotion. Defaults to 0.
    
    Returns:
    
    the promotionId
  - setPromotionId
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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
  - getCustom1
```
public java.lang.String getCustom1()
```
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
public java.lang.String getCustom2()
```
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom3
```
public java.lang.String getCustom3()
```
    Returns:
    
    the custom3
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom4
```
public java.lang.String getCustom4()
```
    Returns:
    
    the custom4
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - the custom4 to set
  - getCustom5
```
public java.lang.String getCustom5()
```
    Returns:
    
    the custom5
  - setCustom5
```
public void setCustom5(java.lang.String custom5)
```
    Parameters:
    
    custom5 - the custom5 to set
  - getTaxRate
```
public java.math.BigDecimal getTaxRate()
```
    Returns:
    
    the taxRate
  - setTaxRate
```
public void setTaxRate(java.math.BigDecimal taxRate)
```
    Parameters:
    
    taxRate - the taxRate to set
  - getCode
```
public java.lang.String getCode()
```
    Returns:
    
    the code
  - setCode
```
public void setCode(java.lang.String code)
```
    Parameters:
    
    code - the code to set

Class AdminOrderTotal

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

orderId

promotionId

title

text

code

value

taxRate

discountAmount

discountPercent

className

sortOrder

custom1

custom2

custom3

custom4

custom5

Constructor Detail

AdminOrderTotal

AdminOrderTotal

Method Detail

toString

getClassName

setClassName

getId

setId

getOrderId

setOrderId

getSortOrder

setSortOrder

getText

setText

getTitle

setTitle

getValue

setValue

getPromotionId

setPromotionId

getDiscountAmount

setDiscountAmount

getDiscountPercent

setDiscountPercent

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

getTaxRate

setTaxRate

getCode

setCode