OrderIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

Order
```
public interface OrderIf
```
Contains all data required to describe an order for use within KonaKart.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.math.BigDecimal`	`getAdminDiscount()` Discount added by an admin user and picked up by a promotion module
`java.lang.String`	`getAffiliateId()` Id of affiliate partner
`OrderIf[]`	`getArchivedOrders()` The archived orders of this order.
`java.lang.String`	`getArchiveId()` Used to reference archived orders
`PaymentDetailsIf[]`	`getAvailablePaymentGateways()` The payment gateways available for the order
`ShippingQuoteIf[]`	`getAvailableShippingQuotes()` The shipping quotes available for this order
`int`	`getBillingAddrFormatId()` The id of the address format template used to format the billing address.
`java.lang.String`	`getBillingAddrFormatTemplate()` The address format template for the billing address.
`int`	`getBillingAddrId()`
`java.lang.String`	`getBillingCity()`
`java.lang.String`	`getBillingCompany()`
`java.lang.String`	`getBillingCountry()`
`java.lang.String`	`getBillingEmail()`
`java.lang.String`	`getBillingFormattedAddress()` The formatted billing address which has been formatted using the address format template.
`java.lang.String`	`getBillingName()`
`java.lang.String`	`getBillingPostcode()`
`java.lang.String`	`getBillingState()`
`java.lang.String`	`getBillingStreetAddress()`
`java.lang.String`	`getBillingStreetAddress1()`
`java.lang.String`	`getBillingSuburb()`
`java.lang.String`	`getBillingTelephone()`
`java.lang.String`	`getBillingTelephone1()`
`java.lang.String`	`getCcCVV()` Credit card ccCVV
`java.lang.String`	`getCcExpires()`
`java.lang.String`	`getCcNumber()`
`java.lang.String`	`getCcOwner()`
`java.lang.String`	`getCcType()`
`java.lang.String`	`getCouponCode()` The coupon code used when checking out.
`java.lang.String`	`getCouponIds()` A comma separated list of coupon ids.
`java.lang.String`	`getCreator()` Identifier of the administrator who created the order
`CurrencyIf`	`getCurrency()`
`java.lang.String`	`getCurrencyCode()` The three letter currency code.
`java.math.BigDecimal`	`getCurrencyValue()` The exchange rate for the currency.
`java.lang.String`	`getCustom1()`
`java.lang.String`	`getCustom10()`
`java.lang.String`	`getCustom11()`
`java.lang.String`	`getCustom12()`
`java.lang.String`	`getCustom13()`
`java.lang.String`	`getCustom14()`
`java.lang.String`	`getCustom15()`
`java.lang.String`	`getCustom16()`
`java.lang.String`	`getCustom2()`
`java.lang.String`	`getCustom3()`
`java.lang.String`	`getCustom4()`
`java.lang.String`	`getCustom5()`
`java.lang.String`	`getCustom6()`
`java.lang.String`	`getCustom7()`
`java.lang.String`	`getCustom8()`
`java.lang.String`	`getCustom9()`
`int`	`getCustomerAddrFormatId()` The id of the address format template used to format the customer address.
`java.lang.String`	`getCustomerAddrFormatTemplate()` The address format template for the customer address.
`int`	`getCustomerAddrId()`
`java.lang.String`	`getCustomerCity()`
`java.lang.String`	`getCustomerCompany()`
`java.lang.String`	`getCustomerCountry()`
`java.lang.String`	`getCustomerEmail()`
`java.lang.String`	`getCustomerFormattedAddress()` The formatted customer address which has been formatted using the address format template.
`int`	`getCustomerId()`
`java.lang.String`	`getCustomerName()`
`java.lang.String`	`getCustomerPostcode()`
`java.lang.String`	`getCustomerState()`
`java.lang.String`	`getCustomerStreetAddress()`
`java.lang.String`	`getCustomerStreetAddress1()`
`java.lang.String`	`getCustomerSuburb()`
`java.lang.String`	`getCustomerTelephone()`
`java.lang.String`	`getCustomerTelephone1()`
`java.util.Calendar`	`getDateFinished()`
`java.util.Calendar`	`getDatePurchased()` The date that the order was saved.
`int`	`getDeliveryAddrFormatId()` The id of the address format template used to format the delivery address.
`java.lang.String`	`getDeliveryAddrFormatTemplate()` The address format template for the delivery address.
`int`	`getDeliveryAddrId()`
`java.lang.String`	`getDeliveryCity()`
`java.lang.String`	`getDeliveryCompany()`
`java.lang.String`	`getDeliveryCountry()`
`CountryIf`	`getDeliveryCountryObject()`
`java.lang.String`	`getDeliveryEmail()`
`java.lang.String`	`getDeliveryFormattedAddress()` The formatted delivery address which has been formatted using the address format template.
`java.lang.String`	`getDeliveryName()`
`java.lang.String`	`getDeliveryPostcode()`
`java.lang.String`	`getDeliveryState()`
`java.lang.String`	`getDeliveryStreetAddress()`
`java.lang.String`	`getDeliveryStreetAddress1()`
`java.lang.String`	`getDeliverySuburb()`
`java.lang.String`	`getDeliveryTelephone()`
`java.lang.String`	`getDeliveryTelephone1()`
`ZoneIf`	`getDeliveryZoneObject()`
`java.lang.String`	`getFilter1()`
`java.lang.String`	`getFilter2()`
`java.math.BigDecimal`	`getFilterDecimal1()`
`java.lang.String`	`getGiftCertCode()` The code of the gift certificate.
`int`	`getId()`
`java.lang.String`	`getInvoiceFilename()` The filename of the invoice (add this to the base URL or base directory path configuration parameters to get the full name)
`java.util.Calendar`	`getLastModified()`
`java.lang.String`	`getLifecycleId()` Instantiated when the order is created.
`java.lang.String`	`getLocale()` Locale of the customer
`ManufacturerIf`	`getManufacturer()`
`int`	`getManufacturerAddrFormatId()`
`java.lang.String`	`getManufacturerAddrFormatTemplate()`
`int`	`getManufacturerAddrId()`
`java.lang.String`	`getManufacturerCity()`
`java.lang.String`	`getManufacturerCompany()`
`java.lang.String`	`getManufacturerCountry()`
`java.lang.String`	`getManufacturerEmail()`
`java.lang.String`	`getManufacturerFormattedAddress()`
`java.lang.String`	`getManufacturerName()`
`java.lang.String`	`getManufacturerPostcode()`
`java.lang.String`	`getManufacturerState()`
`java.lang.String`	`getManufacturerStreetAddress()`
`java.lang.String`	`getManufacturerStreetAddress1()`
`java.lang.String`	`getManufacturerSuburb()`
`java.lang.String`	`getManufacturerTelephone()`
`java.lang.String`	`getManufacturerTelephone1()`
`int`	`getNumProducts()`
`java.lang.String`	`getOrderNumber()` The order number of the order
`OrderProductIf[]`	`getOrderProducts()` An array of OrderProduct objects which define the products contained within the order.
`OrderShipmentIf[]`	`getOrderShipments()` An array of objects containing shipment information
`OrderTotalIf[]`	`getOrderTotals()` An array of OrderTotal objects that contain information such as the sub total, the shipping, the discount and the total.
`int`	`getParentId()` Id of the parent order used when in multi-vendor mode
`PaymentDetailsIf`	`getPaymentDetails()`
`java.lang.String`	`getPaymentMethod()`
`java.lang.String`	`getPaymentModuleCode()` The code of the payment module used for the order (e.g.
`java.lang.String`	`getPaymentModuleSubCode()` The payment sub-code (typically used when a payment module has multiple payment methods)
`int`	`getPointsAwarded()` The number of Reward Points rewarded for the order
`int`	`getPointsRedeemed()` The number of Reward Points redeemed for the order
`int`	`getPointsReservationId()` The numeric id of the points reserved for this order.
`java.lang.String`	`getPromotionIds()` A comma separated list of promotion ids.
`java.lang.String`	`getShippingMethod()` This virtual attribute is set by retrieving the shipping method from the "ot_shipping" order total object.
`java.lang.String`	`getShippingModuleCode()` The code of the shipping module used for the order (i.e.
`ShippingQuoteIf`	`getShippingQuote()`
`java.lang.String`	`getShippingServiceCode()` Used for shipping modules such as UPS, FedEx etc.
`int`	`getStatus()` The current integer status id.
`java.lang.String`	`getStatusText()` Text explaining the status.
`OrderStatusHistoryIf[]`	`getStatusTrail()` An array of OrderStatusHistory objects used to keep track of all status changes during the life cycle of the order.
`java.lang.String`	`getStoreId()` Id of the store that the order belongs to.
`java.lang.String`	`getStoreName()` Name of the store that the order belongs to.
`java.math.BigDecimal`	`getSubTotalExTax()`
`java.math.BigDecimal`	`getSubTotalIncTax()`
`java.math.BigDecimal`	`getTax()`
`TaxRateIf[]`	`getTaxRateObjectArray()` The order may be subject to multiple tax rates which are compounded.
`java.math.BigDecimal`	`getTotalExTax()`
`java.math.BigDecimal`	`getTotalIncTax()`
`java.lang.String`	`getTrackingNumber()` The tracking number of the order.
`OrderIf[]`	`getVendorOrders()` When in multi-vendor mode, the array contains orders for each individual vendor
`void`	`setAdminDiscount(java.math.BigDecimal adminDiscount)` Discount added by an admin user and picked up by a promotion module
`void`	`setAffiliateId(java.lang.String affiliateId)` Id of affiliate partner
`void`	`setArchivedOrders(OrderIf[] archivedOrders)` The archived orders of this order.
`void`	`setArchiveId(java.lang.String archiveId)` Used to reference archived orders
`void`	`setAvailablePaymentGateways(PaymentDetailsIf[] availablePaymentGateways)` The payment gateways available for the order
`void`	`setAvailableShippingQuotes(ShippingQuoteIf[] availableShippingQuotes)` The shipping quotes available for this order
`void`	`setBillingAddrFormatId(int billingAddrFormatId)` The id of the address format template used to format the billing address.
`void`	`setBillingAddrFormatTemplate(java.lang.String billingAddrFormatTemplate)` The address format template for the billing address.
`void`	`setBillingAddrId(int billingAddrId)`
`void`	`setBillingCity(java.lang.String billingCity)`
`void`	`setBillingCompany(java.lang.String billingCompany)`
`void`	`setBillingCountry(java.lang.String billingCountry)`
`void`	`setBillingEmail(java.lang.String billingEmail)`
`void`	`setBillingFormattedAddress(java.lang.String billingFormattedAddress)` The formatted billing address which has been formatted using the address format template.
`void`	`setBillingName(java.lang.String billingName)`
`void`	`setBillingPostcode(java.lang.String billingPostcode)`
`void`	`setBillingState(java.lang.String billingState)`
`void`	`setBillingStreetAddress(java.lang.String billingStreetAddress)`
`void`	`setBillingStreetAddress1(java.lang.String billingStreetAddress1)`
`void`	`setBillingSuburb(java.lang.String billingSuburb)`
`void`	`setBillingTelephone(java.lang.String billingTelephone)`
`void`	`setBillingTelephone1(java.lang.String billingTelephone1)`
`void`	`setCcCVV(java.lang.String ccCVV)` Credit card ccCVV
`void`	`setCcExpires(java.lang.String ccExpires)`
`void`	`setCcNumber(java.lang.String ccNumber)`
`void`	`setCcOwner(java.lang.String ccOwner)`
`void`	`setCcType(java.lang.String ccType)`
`void`	`setCouponCode(java.lang.String couponCode)` The coupon code used when checking out.
`void`	`setCouponIds(java.lang.String couponIds)` A comma separated list of coupon ids.
`void`	`setCreator(java.lang.String creator)` Identifier of the administrator who created the order
`void`	`setCurrency(CurrencyIf currency)`
`void`	`setCurrencyCode(java.lang.String currencyCode)` The three letter currency code.
`void`	`setCurrencyValue(java.math.BigDecimal currencyValue)` The exchange rate for the currency.
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom10(java.lang.String custom10)`
`void`	`setCustom11(java.lang.String custom11)`
`void`	`setCustom12(java.lang.String custom12)`
`void`	`setCustom13(java.lang.String custom13)`
`void`	`setCustom14(java.lang.String custom14)`
`void`	`setCustom15(java.lang.String custom15)`
`void`	`setCustom16(java.lang.String custom16)`
`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`	`setCustom6(java.lang.String custom6)`
`void`	`setCustom7(java.lang.String custom7)`
`void`	`setCustom8(java.lang.String custom8)`
`void`	`setCustom9(java.lang.String custom9)`
`void`	`setCustomerAddrFormatId(int customerAddrFormatId)` The id of the address format template used to format the customer address.
`void`	`setCustomerAddrFormatTemplate(java.lang.String customerAddrFormatTemplate)` The address format template for the customer address.
`void`	`setCustomerAddrId(int customerAddrId)`
`void`	`setCustomerCity(java.lang.String customerCity)`
`void`	`setCustomerCompany(java.lang.String customerCompany)`
`void`	`setCustomerCountry(java.lang.String customerCountry)`
`void`	`setCustomerEmail(java.lang.String customerEmail)`
`void`	`setCustomerFormattedAddress(java.lang.String customerFormattedAddress)` The formatted customer address which has been formatted using the address format template.
`void`	`setCustomerId(int customerId)`
`void`	`setCustomerName(java.lang.String customerName)`
`void`	`setCustomerPostcode(java.lang.String customerPostcode)`
`void`	`setCustomerState(java.lang.String customerState)`
`void`	`setCustomerStreetAddress(java.lang.String customerStreetAddress)`
`void`	`setCustomerStreetAddress1(java.lang.String customerStreetAddress1)`
`void`	`setCustomerSuburb(java.lang.String customerSuburb)`
`void`	`setCustomerTelephone(java.lang.String customerTelephone)`
`void`	`setCustomerTelephone1(java.lang.String customerTelephone1)`
`void`	`setDateFinished(java.util.Calendar dateFinished)`
`void`	`setDatePurchased(java.util.Calendar datePurchased)` The date that the order was saved.
`void`	`setDeliveryAddrFormatId(int deliveryAddrFormatId)` The id of the address format template used to format the delivery address.
`void`	`setDeliveryAddrFormatTemplate(java.lang.String deliveryAddrFormatTemplate)` The address format template for the delivery address.
`void`	`setDeliveryAddrId(int deliveryAddrId)`
`void`	`setDeliveryCity(java.lang.String deliveryCity)`
`void`	`setDeliveryCompany(java.lang.String deliveryCompany)`
`void`	`setDeliveryCountry(java.lang.String deliveryCountry)`
`void`	`setDeliveryCountryObject(CountryIf deliveryCountryObject)`
`void`	`setDeliveryEmail(java.lang.String deliveryEmail)`
`void`	`setDeliveryFormattedAddress(java.lang.String deliveryFormattedAddress)` The formatted delivery address which has been formatted using the address format template.
`void`	`setDeliveryName(java.lang.String deliveryName)`
`void`	`setDeliveryPostcode(java.lang.String deliveryPostcode)`
`void`	`setDeliveryState(java.lang.String deliveryState)`
`void`	`setDeliveryStreetAddress(java.lang.String deliveryStreetAddress)`
`void`	`setDeliveryStreetAddress1(java.lang.String deliveryStreetAddress1)`
`void`	`setDeliverySuburb(java.lang.String deliverySuburb)`
`void`	`setDeliveryTelephone(java.lang.String deliveryTelephone)`
`void`	`setDeliveryTelephone1(java.lang.String deliveryTelephone1)`
`void`	`setDeliveryZoneObject(ZoneIf deliveryZoneObject)`
`void`	`setFilter1(java.lang.String filter1)`
`void`	`setFilter2(java.lang.String filter2)`
`void`	`setFilterDecimal1(java.math.BigDecimal filterDecimal1)`
`void`	`setGiftCertCode(java.lang.String giftCertCode)` The code of the gift certificate.
`void`	`setId(int id)`
`void`	`setInvoiceFilename(java.lang.String invoiceFilename)` The filename of the invoice
`void`	`setLastModified(java.util.Calendar lastModified)`
`void`	`setLifecycleId(java.lang.String lifecycleId)` Instantiated when the order is created.
`void`	`setLocale(java.lang.String locale)` Locale of the customer
`void`	`setManufacturer(ManufacturerIf manufacturer)`
`void`	`setManufacturerAddrFormatId(int manufacturerAddrFormatId)`
`void`	`setManufacturerAddrFormatTemplate(java.lang.String manufacturerAddrFormatTemplate)`
`void`	`setManufacturerAddrId(int manufacturerAddrId)`
`void`	`setManufacturerCity(java.lang.String manufacturerCity)`
`void`	`setManufacturerCompany(java.lang.String manufacturerCompany)`
`void`	`setManufacturerCountry(java.lang.String manufacturerCountry)`
`void`	`setManufacturerEmail(java.lang.String manufacturerEmail)`
`void`	`setManufacturerFormattedAddress(java.lang.String manufacturerFormattedAddress)`
`void`	`setManufacturerName(java.lang.String manufacturerName)`
`void`	`setManufacturerPostcode(java.lang.String manufacturerPostcode)`
`void`	`setManufacturerState(java.lang.String manufacturerState)`
`void`	`setManufacturerStreetAddress(java.lang.String manufacturerStreetAddress)`
`void`	`setManufacturerStreetAddress1(java.lang.String manufacturerStreetAddress1)`
`void`	`setManufacturerSuburb(java.lang.String manufacturerSuburb)`
`void`	`setManufacturerTelephone(java.lang.String manufacturerTelephone)`
`void`	`setManufacturerTelephone1(java.lang.String manufacturerTelephone1)`
`void`	`setNumProducts(int numProducts)`
`void`	`setOrderNumber(java.lang.String orderNumber)` The order number of the order
`void`	`setOrderProducts(OrderProductIf[] orderProducts)` An array of OrderProduct objects which define the products contained within the order.
`void`	`setOrderShipments(OrderShipmentIf[] orderShipments)` An array of objects containing shipment information
`void`	`setOrderTotals(OrderTotalIf[] orderTotals)` An array of OrderTotal objects that contain information such as the sub total, the shipping, the discount and the total.
`void`	`setParentId(int parentId)` Id of the parent order used when in multi-vendor mode
`void`	`setPaymentDetails(PaymentDetailsIf paymentDetails)`
`void`	`setPaymentMethod(java.lang.String paymentMethod)`
`void`	`setPaymentModuleCode(java.lang.String paymentModuleCode)` The code of the payment module used for the order (e.g.
`void`	`setPaymentModuleSubCode(java.lang.String paymentModuleSubCode)` The payment sub-code (typically used when a payment module has multiple payment methods)
`void`	`setPointsAwarded(int pointsAwarded)` The number of Reward Points rewarded for the order
`void`	`setPointsRedeemed(int pointsRedeemed)` The number of Reward Points redeemed for the order
`void`	`setPointsReservationId(int pointsReservationId)` The numeric id of the points reserved for this order.
`void`	`setPromotionIds(java.lang.String promotionIds)` A comma separated list of promotion ids.
`void`	`setShippingMethod(java.lang.String shippingMethod)`
`void`	`setShippingModuleCode(java.lang.String shippingModuleCode)` The code of the shipping module used for the order (i.e.
`void`	`setShippingQuote(ShippingQuoteIf shippingQuote)`
`void`	`setShippingServiceCode(java.lang.String shippingServiceCode)` Used for shipping modules such as UPS, FedEx etc.
`void`	`setStatus(int status)` The current integer status id.
`void`	`setStatusText(java.lang.String statusText)` Text explaining the status.
`void`	`setStatusTrail(OrderStatusHistoryIf[] statusTrail)` An array of OrderStatusHistory objects used to keep track of all status changes during the life cycle of the order.
`void`	`setStoreId(java.lang.String storeId)` Id of the store that the order belongs to.
`void`	`setStoreName(java.lang.String storeName)` Name of the store that the order belongs to
`void`	`setSubTotalExTax(java.math.BigDecimal subTotalExTax)`
`void`	`setSubTotalIncTax(java.math.BigDecimal subTotalIncTax)`
`void`	`setTax(java.math.BigDecimal tax)`
`void`	`setTaxRateObjectArray(TaxRateIf[] taxRateObjectArray)` The order may be subject to multiple tax rates which are compounded.
`void`	`setTotalExTax(java.math.BigDecimal totalExTax)`
`void`	`setTotalIncTax(java.math.BigDecimal totalIncTax)`
`void`	`setTrackingNumber(java.lang.String trackingNumber)` The tracking number of the order.
`void`	`setVendorOrders(OrderIf[] vendorOrders)` When in multi-vendor mode, the array contains orders for each individual vendor

- Method Detail
  - getBillingCity
```
java.lang.String getBillingCity()
```
    Returns:
    
    Returns the billingCity.
  - setBillingCity
```
void setBillingCity(java.lang.String billingCity)
```
    Parameters:
    
    billingCity - The billingCity to set.
  - getBillingCompany
```
java.lang.String getBillingCompany()
```
    Returns:
    
    Returns the billingCompany.
  - setBillingCompany
```
void setBillingCompany(java.lang.String billingCompany)
```
    Parameters:
    
    billingCompany - The billingCompany to set.
  - getBillingCountry
```
java.lang.String getBillingCountry()
```
    Returns:
    
    Returns the billingCountry.
  - setBillingCountry
```
void setBillingCountry(java.lang.String billingCountry)
```
    Parameters:
    
    billingCountry - The billingCountry to set.
  - getBillingName
```
java.lang.String getBillingName()
```
    Returns:
    
    Returns the billingName.
  - setBillingName
```
void setBillingName(java.lang.String billingName)
```
    Parameters:
    
    billingName - The billingName to set.
  - getBillingPostcode
```
java.lang.String getBillingPostcode()
```
    Returns:
    
    Returns the billingPostcode.
  - setBillingPostcode
```
void setBillingPostcode(java.lang.String billingPostcode)
```
    Parameters:
    
    billingPostcode - The billingPostcode to set.
  - getBillingState
```
java.lang.String getBillingState()
```
    Returns:
    
    Returns the billingState.
  - setBillingState
```
void setBillingState(java.lang.String billingState)
```
    Parameters:
    
    billingState - The billingState to set.
  - getBillingStreetAddress
```
java.lang.String getBillingStreetAddress()
```
    Returns:
    
    Returns the billingStreetAddress.
  - setBillingStreetAddress
```
void setBillingStreetAddress(java.lang.String billingStreetAddress)
```
    Parameters:
    
    billingStreetAddress - The billingStreetAddress to set.
  - getBillingStreetAddress1
```
java.lang.String getBillingStreetAddress1()
```
    Returns:
    
    the billingStreetAddress1
  - setBillingStreetAddress1
```
void setBillingStreetAddress1(java.lang.String billingStreetAddress1)
```
    Parameters:
    
    billingStreetAddress1 - the billingStreetAddress1 to set
  - getBillingSuburb
```
java.lang.String getBillingSuburb()
```
    Returns:
    
    Returns the billingSuburb.
  - setBillingSuburb
```
void setBillingSuburb(java.lang.String billingSuburb)
```
    Parameters:
    
    billingSuburb - The billingSuburb to set.
  - getCcExpires
```
java.lang.String getCcExpires()
```
    Returns:
    
    Returns the ccExpires.
  - setCcExpires
```
void setCcExpires(java.lang.String ccExpires)
```
    Parameters:
    
    ccExpires - The ccExpires to set.
  - getCcNumber
```
java.lang.String getCcNumber()
```
    Returns:
    
    Returns the ccNumber.
  - setCcNumber
```
void setCcNumber(java.lang.String ccNumber)
```
    Parameters:
    
    ccNumber - The ccNumber to set.
  - getCcOwner
```
java.lang.String getCcOwner()
```
    Returns:
    
    Returns the ccOwner.
  - setCcOwner
```
void setCcOwner(java.lang.String ccOwner)
```
    Parameters:
    
    ccOwner - The ccOwner to set.
  - getCcType
```
java.lang.String getCcType()
```
    Returns:
    
    Returns the ccType.
  - setCcType
```
void setCcType(java.lang.String ccType)
```
    Parameters:
    
    ccType - The ccType to set.
  - getCurrencyValue
```
java.math.BigDecimal getCurrencyValue()
```
    The exchange rate for the currency.
    
    Returns:
    
    Returns the currencyValue.
  - setCurrencyValue
```
void setCurrencyValue(java.math.BigDecimal currencyValue)
```
    The exchange rate for the currency.
    
    Parameters:
    
    currencyValue - The currencyValue to set.
  - getCustomerCity
```
java.lang.String getCustomerCity()
```
    Returns:
    
    Returns the customerCity.
  - setCustomerCity
```
void setCustomerCity(java.lang.String customerCity)
```
    Parameters:
    
    customerCity - The customerCity to set.
  - getCustomerCompany
```
java.lang.String getCustomerCompany()
```
    Returns:
    
    Returns the customerCompany.
  - setCustomerCompany
```
void setCustomerCompany(java.lang.String customerCompany)
```
    Parameters:
    
    customerCompany - The customerCompany to set.
  - getCustomerCountry
```
java.lang.String getCustomerCountry()
```
    Returns:
    
    Returns the customerCountry.
  - setCustomerCountry
```
void setCustomerCountry(java.lang.String customerCountry)
```
    Parameters:
    
    customerCountry - The customerCountry to set.
  - getCustomerEmail
```
java.lang.String getCustomerEmail()
```
    Returns:
    
    Returns the customerEmail.
  - setCustomerEmail
```
void setCustomerEmail(java.lang.String customerEmail)
```
    Parameters:
    
    customerEmail - The customerEmail to set.
  - getCustomerName
```
java.lang.String getCustomerName()
```
    Returns:
    
    Returns the customerName.
  - setCustomerName
```
void setCustomerName(java.lang.String customerName)
```
    Parameters:
    
    customerName - The customerName to set.
  - getCustomerPostcode
```
java.lang.String getCustomerPostcode()
```
    Returns:
    
    Returns the customerPostcode.
  - setCustomerPostcode
```
void setCustomerPostcode(java.lang.String customerPostcode)
```
    Parameters:
    
    customerPostcode - The customerPostcode to set.
  - getCustomerState
```
java.lang.String getCustomerState()
```
    Returns:
    
    Returns the customerState.
  - setCustomerState
```
void setCustomerState(java.lang.String customerState)
```
    Parameters:
    
    customerState - The customerState to set.
  - getCustomerStreetAddress
```
java.lang.String getCustomerStreetAddress()
```
    Returns:
    
    Returns the customerStreetAddress.
  - setCustomerStreetAddress
```
void setCustomerStreetAddress(java.lang.String customerStreetAddress)
```
    Parameters:
    
    customerStreetAddress - The customerStreetAddress to set.
  - getCustomerStreetAddress1
```
java.lang.String getCustomerStreetAddress1()
```
    Returns:
    
    the customerStreetAddress1
  - setCustomerStreetAddress1
```
void setCustomerStreetAddress1(java.lang.String customerStreetAddress1)
```
    Parameters:
    
    customerStreetAddress1 - the customerStreetAddress1 to set
  - getCustomerSuburb
```
java.lang.String getCustomerSuburb()
```
    Returns:
    
    Returns the customerSuburb.
  - setCustomerSuburb
```
void setCustomerSuburb(java.lang.String customerSuburb)
```
    Parameters:
    
    customerSuburb - The customerSuburb to set.
  - getCustomerTelephone
```
java.lang.String getCustomerTelephone()
```
    Returns:
    
    Returns the customerTelephone.
  - setCustomerTelephone
```
void setCustomerTelephone(java.lang.String customerTelephone)
```
    Parameters:
    
    customerTelephone - The customerTelephone to set.
  - getDateFinished
```
java.util.Calendar getDateFinished()
```
    Returns:
    
    Returns the dateFinished.
  - setDateFinished
```
void setDateFinished(java.util.Calendar dateFinished)
```
    Parameters:
    
    dateFinished - The dateFinished to set.
  - getDatePurchased
```
java.util.Calendar getDatePurchased()
```
    The date that the order was saved.
    
    Returns:
    
    Returns the datePurchased.
  - setDatePurchased
```
void setDatePurchased(java.util.Calendar datePurchased)
```
    The date that the order was saved.
    
    Parameters:
    
    datePurchased - The datePurchased to set.
  - getDeliveryCity
```
java.lang.String getDeliveryCity()
```
    Returns:
    
    Returns the deliveryCity.
  - setDeliveryCity
```
void setDeliveryCity(java.lang.String deliveryCity)
```
    Parameters:
    
    deliveryCity - The deliveryCity to set.
  - getDeliveryCompany
```
java.lang.String getDeliveryCompany()
```
    Returns:
    
    Returns the deliveryCompany.
  - setDeliveryCompany
```
void setDeliveryCompany(java.lang.String deliveryCompany)
```
    Parameters:
    
    deliveryCompany - The deliveryCompany to set.
  - getDeliveryCountry
```
java.lang.String getDeliveryCountry()
```
    Returns:
    
    Returns the deliveryCountry.
  - setDeliveryCountry
```
void setDeliveryCountry(java.lang.String deliveryCountry)
```
    Parameters:
    
    deliveryCountry - The deliveryCountry to set.
  - getDeliveryName
```
java.lang.String getDeliveryName()
```
    Returns:
    
    Returns the deliveryName.
  - setDeliveryName
```
void setDeliveryName(java.lang.String deliveryName)
```
    Parameters:
    
    deliveryName - The deliveryName to set.
  - getDeliveryPostcode
```
java.lang.String getDeliveryPostcode()
```
    Returns:
    
    Returns the deliveryPostcode.
  - setDeliveryPostcode
```
void setDeliveryPostcode(java.lang.String deliveryPostcode)
```
    Parameters:
    
    deliveryPostcode - The deliveryPostcode to set.
  - getDeliveryState
```
java.lang.String getDeliveryState()
```
    Returns:
    
    Returns the deliveryState.
  - setDeliveryState
```
void setDeliveryState(java.lang.String deliveryState)
```
    Parameters:
    
    deliveryState - The deliveryState to set.
  - getDeliveryStreetAddress
```
java.lang.String getDeliveryStreetAddress()
```
    Returns:
    
    Returns the deliveryStreetAddress.
  - setDeliveryStreetAddress
```
void setDeliveryStreetAddress(java.lang.String deliveryStreetAddress)
```
    Parameters:
    
    deliveryStreetAddress - The deliveryStreetAddress to set.
  - getDeliveryStreetAddress1
```
java.lang.String getDeliveryStreetAddress1()
```
    Returns:
    
    the deliveryStreetAddress1
  - setDeliveryStreetAddress1
```
void setDeliveryStreetAddress1(java.lang.String deliveryStreetAddress1)
```
    Parameters:
    
    deliveryStreetAddress1 - the deliveryStreetAddress1 to set
  - getDeliverySuburb
```
java.lang.String getDeliverySuburb()
```
    Returns:
    
    Returns the deliverySuburb.
  - setDeliverySuburb
```
void setDeliverySuburb(java.lang.String deliverySuburb)
```
    Parameters:
    
    deliverySuburb - The deliverySuburb to set.
  - getId
```
int getId()
```
    Returns:
    
    Returns the id.
  - setId
```
void setId(int id)
```
    Parameters:
    
    id - The id to set.
  - getLastModified
```
java.util.Calendar getLastModified()
```
    Returns:
    
    Returns the lastModified.
  - setLastModified
```
void setLastModified(java.util.Calendar lastModified)
```
    Parameters:
    
    lastModified - The lastModified to set.
  - getPaymentMethod
```
java.lang.String getPaymentMethod()
```
    Returns:
    
    Returns the paymentMethod.
  - setPaymentMethod
```
void setPaymentMethod(java.lang.String paymentMethod)
```
    Parameters:
    
    paymentMethod - The paymentMethod to set.
  - getShippingMethod
```
java.lang.String getShippingMethod()
```
    This virtual attribute is set by retrieving the shipping method from the "ot_shipping" order total object.
    
    Returns:
    
    Returns the shippingMethod.
  - setShippingMethod
```
void setShippingMethod(java.lang.String shippingMethod)
```
    Parameters:
    
    shippingMethod - The shippingMethod to set.
  - getStatus
```
int getStatus()
```
    The current integer status id. The orders_status table contains a description of this status id.
    
    Returns:
    
    Returns the status.
  - setStatus
```
void setStatus(int status)
```
    The current integer status id. The orders_status table contains a description of this status id.
    
    Parameters:
    
    status - The status to set.
  - getCustomerId
```
int getCustomerId()
```
    Returns:
    
    Returns the customerId.
  - setCustomerId
```
void setCustomerId(int customerId)
```
    Parameters:
    
    customerId - The customerId to set.
  - getBillingAddrFormatId
```
int getBillingAddrFormatId()
```
    The id of the address format template used to format the billing address.
    
    Returns:
    
    Returns the billingAddrFormatId.
  - setBillingAddrFormatId
```
void setBillingAddrFormatId(int billingAddrFormatId)
```
    The id of the address format template used to format the billing address.
    
    Parameters:
    
    billingAddrFormatId - The billingAddrFormatId to set.
  - getCustomerAddrFormatId
```
int getCustomerAddrFormatId()
```
    The id of the address format template used to format the customer address.
    
    Returns:
    
    Returns the customerAddrFormatId.
  - setCustomerAddrFormatId
```
void setCustomerAddrFormatId(int customerAddrFormatId)
```
    The id of the address format template used to format the customer address.
    
    Parameters:
    
    customerAddrFormatId - The customerAddrFormatId to set.
  - getDeliveryAddrFormatId
```
int getDeliveryAddrFormatId()
```
    The id of the address format template used to format the delivery address.
    
    Returns:
    
    Returns the deliveryAddrFormatId.
  - setDeliveryAddrFormatId
```
void setDeliveryAddrFormatId(int deliveryAddrFormatId)
```
    The id of the address format template used to format the delivery address.
    
    Parameters:
    
    deliveryAddrFormatId - The deliveryAddrFormatId to set.
  - getOrderProducts
```
OrderProductIf[] getOrderProducts()
```
    An array of OrderProduct objects which define the products contained within the order.
    
    Returns:
    
    Returns the orderProducts.
  - setOrderProducts
```
void setOrderProducts(OrderProductIf[] orderProducts)
```
    An array of OrderProduct objects which define the products contained within the order.
    
    Parameters:
    
    orderProducts - The orderProducts to set.
  - getBillingFormattedAddress
```
java.lang.String getBillingFormattedAddress()
```
    The formatted billing address which has been formatted using the address format template.
    
    Returns:
    
    Returns the billingFormattedAddress.
  - setBillingFormattedAddress
```
void setBillingFormattedAddress(java.lang.String billingFormattedAddress)
```
    The formatted billing address which has been formatted using the address format template.
    
    Parameters:
    
    billingFormattedAddress - The billingFormattedAddress to set.
  - getCustomerFormattedAddress
```
java.lang.String getCustomerFormattedAddress()
```
    The formatted customer address which has been formatted using the address format template.
    
    Returns:
    
    Returns the customerFormattedAddress.
  - setCustomerFormattedAddress
```
void setCustomerFormattedAddress(java.lang.String customerFormattedAddress)
```
    The formatted customer address which has been formatted using the address format template.
    
    Parameters:
    
    customerFormattedAddress - The customerFormattedAddress to set.
  - getDeliveryFormattedAddress
```
java.lang.String getDeliveryFormattedAddress()
```
    The formatted delivery address which has been formatted using the address format template.
    
    Returns:
    
    Returns the deliveryFormattedAddress.
  - setDeliveryFormattedAddress
```
void setDeliveryFormattedAddress(java.lang.String deliveryFormattedAddress)
```
    The formatted delivery address which has been formatted using the address format template.
    
    Parameters:
    
    deliveryFormattedAddress - The deliveryFormattedAddress to set.
  - getStatusText
```
java.lang.String getStatusText()
```
    Text explaining the status.
    
    Returns:
    
    Returns the statusText.
  - setStatusText
```
void setStatusText(java.lang.String statusText)
```
    Text explaining the status.
    
    Parameters:
    
    statusText - The statusText to set.
  - getTax
```
java.math.BigDecimal getTax()
```
    Returns:
    
    Returns the tax.
  - setTax
```
void setTax(java.math.BigDecimal tax)
```
    Parameters:
    
    tax - The tax to set.
  - getNumProducts
```
int getNumProducts()
```
    Returns:
    
    Returns the numProducts.
  - setNumProducts
```
void setNumProducts(int numProducts)
```
    Parameters:
    
    numProducts - The numProducts to set.
  - getBillingAddrFormatTemplate
```
java.lang.String getBillingAddrFormatTemplate()
```
    The address format template for the billing address.
    
    Returns:
    
    Returns the billingAddrFormatTemplate.
  - setBillingAddrFormatTemplate
```
void setBillingAddrFormatTemplate(java.lang.String billingAddrFormatTemplate)
```
    The address format template for the billing address.
    
    Parameters:
    
    billingAddrFormatTemplate - The billingAddrFormatTemplate to set.
  - getManufacturer
```
ManufacturerIf getManufacturer()
```
    Returns:
    
    the manufacturer
  - setManufacturer
```
void setManufacturer(ManufacturerIf manufacturer)
```
    Parameters:
    
    manufacturer - the manufacturer to set
  - getManufacturerName
```
java.lang.String getManufacturerName()
```
    Returns:
    
    the manufacturer
  - setManufacturerName
```
void setManufacturerName(java.lang.String manufacturerName)
```
    Parameters:
    
    manufacturerName - the manufacturerName to set
  - getManufacturerCompany
```
java.lang.String getManufacturerCompany()
```
    Returns:
    
    the manufacturerCompany
  - setManufacturerCompany
```
void setManufacturerCompany(java.lang.String manufacturerCompany)
```
    Parameters:
    
    manufacturerCompany - the manufacturerCompany to set
  - getManufacturerAddrId
```
int getManufacturerAddrId()
```
    Returns:
    
    the manufacturerAddrId
  - setManufacturerAddrId
```
void setManufacturerAddrId(int manufacturerAddrId)
```
    Parameters:
    
    manufacturerAddrId - the manufacturerAddrId to set
  - getManufacturerStreetAddress
```
java.lang.String getManufacturerStreetAddress()
```
    Returns:
    
    the manufacturerStreetAddress
  - setManufacturerStreetAddress
```
void setManufacturerStreetAddress(java.lang.String manufacturerStreetAddress)
```
    Parameters:
    
    manufacturerStreetAddress - the manufacturerStreetAddress to set
  - getManufacturerStreetAddress1
```
java.lang.String getManufacturerStreetAddress1()
```
    Returns:
    
    the manufacturerStreetAddress1
  - setManufacturerStreetAddress1
```
void setManufacturerStreetAddress1(java.lang.String manufacturerStreetAddress1)
```
    Parameters:
    
    manufacturerStreetAddress1 - the manufacturerStreetAddress1 to set
  - getManufacturerSuburb
```
java.lang.String getManufacturerSuburb()
```
    Returns:
    
    the manufacturerSuburb
  - setManufacturerSuburb
```
void setManufacturerSuburb(java.lang.String manufacturerSuburb)
```
    Parameters:
    
    manufacturerSuburb - the manufacturerSuburb to set
  - getManufacturerCity
```
java.lang.String getManufacturerCity()
```
    Returns:
    
    the manufacturerCity
  - setManufacturerCity
```
void setManufacturerCity(java.lang.String manufacturerCity)
```
    Parameters:
    
    manufacturerCity - the manufacturerCity to set
  - getManufacturerPostcode
```
java.lang.String getManufacturerPostcode()
```
    Returns:
    
    the manufacturerPostcode
  - setManufacturerPostcode
```
void setManufacturerPostcode(java.lang.String manufacturerPostcode)
```
    Parameters:
    
    manufacturerPostcode - the manufacturerPostcode to set
  - getManufacturerState
```
java.lang.String getManufacturerState()
```
    Returns:
    
    the manufacturerState
  - setManufacturerState
```
void setManufacturerState(java.lang.String manufacturerState)
```
    Parameters:
    
    manufacturerState - the manufacturerState to set
  - getManufacturerCountry
```
java.lang.String getManufacturerCountry()
```
    Returns:
    
    the manufacturerCountry
  - setManufacturerCountry
```
void setManufacturerCountry(java.lang.String manufacturerCountry)
```
    Parameters:
    
    manufacturerCountry - the manufacturerCountry to set
  - getManufacturerTelephone
```
java.lang.String getManufacturerTelephone()
```
    Returns:
    
    the manufacturerTelephone
  - setManufacturerTelephone
```
void setManufacturerTelephone(java.lang.String manufacturerTelephone)
```
    Parameters:
    
    manufacturerTelephone - the manufacturerTelephone to set
  - getManufacturerTelephone1
```
java.lang.String getManufacturerTelephone1()
```
    Returns:
    
    the manufacturerTelephone1
  - setManufacturerTelephone1
```
void setManufacturerTelephone1(java.lang.String manufacturerTelephone1)
```
    Parameters:
    
    manufacturerTelephone1 - the manufacturerTelephone1 to set
  - getManufacturerEmail
```
java.lang.String getManufacturerEmail()
```
    Returns:
    
    the manufacturerEmail
  - setManufacturerEmail
```
void setManufacturerEmail(java.lang.String manufacturerEmail)
```
    Parameters:
    
    manufacturerEmail - the manufacturerEmail to set
  - getManufacturerAddrFormatId
```
int getManufacturerAddrFormatId()
```
    Returns:
    
    the manufacturerAddrFormatId
  - setManufacturerAddrFormatId
```
void setManufacturerAddrFormatId(int manufacturerAddrFormatId)
```
    Parameters:
    
    manufacturerAddrFormatId - the manufacturerAddrFormatId to set
  - getManufacturerAddrFormatTemplate
```
java.lang.String getManufacturerAddrFormatTemplate()
```
    Returns:
    
    the manufacturerAddrFormatTemplate
  - setManufacturerAddrFormatTemplate
```
void setManufacturerAddrFormatTemplate(java.lang.String manufacturerAddrFormatTemplate)
```
    Parameters:
    
    manufacturerAddrFormatTemplate - the manufacturerAddrFormatTemplate to set
  - getManufacturerFormattedAddress
```
java.lang.String getManufacturerFormattedAddress()
```
    Returns:
    
    the manufacturerFormattedAddress
  - setManufacturerFormattedAddress
```
void setManufacturerFormattedAddress(java.lang.String manufacturerFormattedAddress)
```
    Parameters:
    
    manufacturerFormattedAddress - the manufacturerFormattedAddress to set
  - getCustomerAddrFormatTemplate
```
java.lang.String getCustomerAddrFormatTemplate()
```
    The address format template for the customer address.
    
    Returns:
    
    Returns the customerAddrFormatTemplate.
  - setCustomerAddrFormatTemplate
```
void setCustomerAddrFormatTemplate(java.lang.String customerAddrFormatTemplate)
```
    The address format template for the customer address.
    
    Parameters:
    
    customerAddrFormatTemplate - The customerAddrFormatTemplate to set.
  - getDeliveryAddrFormatTemplate
```
java.lang.String getDeliveryAddrFormatTemplate()
```
    The address format template for the delivery address.
    
    Returns:
    
    Returns the deliveryAddrFormatTemplate.
  - setDeliveryAddrFormatTemplate
```
void setDeliveryAddrFormatTemplate(java.lang.String deliveryAddrFormatTemplate)
```
    The address format template for the delivery address.
    
    Parameters:
    
    deliveryAddrFormatTemplate - The deliveryAddrFormatTemplate to set.
  - getOrderTotals
```
OrderTotalIf[] getOrderTotals()
```
    An array of OrderTotal objects that contain information such as the sub total, the shipping, the discount and the total.
    
    Returns:
    
    Returns the orderTotals.
  - setOrderTotals
```
void setOrderTotals(OrderTotalIf[] orderTotals)
```
    An array of OrderTotal objects that contain information such as the sub total, the shipping, the discount and the total.
    
    Parameters:
    
    orderTotals - The orderTotals to set.
  - getStatusTrail
```
OrderStatusHistoryIf[] getStatusTrail()
```
    An array of OrderStatusHistory objects used to keep track of all status changes during the life cycle of the order.
    
    Returns:
    
    Returns the statusTrail.
  - setStatusTrail
```
void setStatusTrail(OrderStatusHistoryIf[] statusTrail)
```
    An array of OrderStatusHistory objects used to keep track of all status changes during the life cycle of the order.
    
    Parameters:
    
    statusTrail - The statusTrail to set.
  - getBillingAddrId
```
int getBillingAddrId()
```
    Returns:
    
    Returns the billingAddrId.
  - setBillingAddrId
```
void setBillingAddrId(int billingAddrId)
```
    Parameters:
    
    billingAddrId - The billingAddrId to set.
  - getCustomerAddrId
```
int getCustomerAddrId()
```
    Returns:
    
    Returns the customerAddrId.
  - setCustomerAddrId
```
void setCustomerAddrId(int customerAddrId)
```
    Parameters:
    
    customerAddrId - The customerAddrId to set.
  - getDeliveryAddrId
```
int getDeliveryAddrId()
```
    Returns:
    
    Returns the deliveryAddrId.
  - setDeliveryAddrId
```
void setDeliveryAddrId(int deliveryAddrId)
```
    Parameters:
    
    deliveryAddrId - The deliveryAddrId to set.
  - getDeliveryCountryObject
```
CountryIf getDeliveryCountryObject()
```
    Returns:
    
    Returns the deliveryCountryObject.
  - setDeliveryCountryObject
```
void setDeliveryCountryObject(CountryIf deliveryCountryObject)
```
    Parameters:
    
    deliveryCountryObject - The deliveryCountryObject to set.
  - getDeliveryZoneObject
```
ZoneIf getDeliveryZoneObject()
```
    Returns:
    
    Returns the deliveryZoneObject.
  - setDeliveryZoneObject
```
void setDeliveryZoneObject(ZoneIf deliveryZoneObject)
```
    Parameters:
    
    deliveryZoneObject - The deliveryZoneObject to set.
  - getTotalExTax
```
java.math.BigDecimal getTotalExTax()
```
    Returns:
    
    Returns the totalExTax.
  - setTotalExTax
```
void setTotalExTax(java.math.BigDecimal totalExTax)
```
    Parameters:
    
    totalExTax - The totalExTax to set.
  - getTotalIncTax
```
java.math.BigDecimal getTotalIncTax()
```
    Returns:
    
    Returns the totalIncTax.
  - setTotalIncTax
```
void setTotalIncTax(java.math.BigDecimal totalIncTax)
```
    Parameters:
    
    totalIncTax - The totalIncTax to set.
  - getShippingQuote
```
ShippingQuoteIf getShippingQuote()
```
    Returns:
    
    Returns the shippingQuote.
  - setShippingQuote
```
void setShippingQuote(ShippingQuoteIf shippingQuote)
```
    Parameters:
    
    shippingQuote - The shippingQuote to set.
  - getCurrencyCode
```
java.lang.String getCurrencyCode()
```
    The three letter currency code. e.g. USD
    
    Returns:
    
    Returns the currencyCode.
  - setCurrencyCode
```
void setCurrencyCode(java.lang.String currencyCode)
```
    The three letter currency code. e.g. USD
    
    Parameters:
    
    currencyCode - The currencyCode to set.
  - getCurrency
```
CurrencyIf getCurrency()
```
    Returns:
    
    Returns the currency.
  - setCurrency
```
void setCurrency(CurrencyIf currency)
```
    Parameters:
    
    currency - The currency to set.
  - getTaxRateObjectArray
```
TaxRateIf[] getTaxRateObjectArray()
```
    The order may be subject to multiple tax rates which are compounded.
    
    Returns:
    
    Returns the taxRateObjectArray.
  - setTaxRateObjectArray
```
void setTaxRateObjectArray(TaxRateIf[] taxRateObjectArray)
```
    The order may be subject to multiple tax rates which are compounded.
    
    Parameters:
    
    taxRateObjectArray - The taxRateObjectArray to set.
  - getPaymentDetails
```
PaymentDetailsIf getPaymentDetails()
```
    Returns:
    
    Returns the paymentDetails.
  - setPaymentDetails
```
void setPaymentDetails(PaymentDetailsIf paymentDetails)
```
    Parameters:
    
    paymentDetails - The paymentDetails to set.
  - getCustom1
```
java.lang.String getCustom1()
```
    Returns:
    
    Returns the custom1.
  - setCustom1
```
void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - The custom1 to set.
  - getCustom2
```
java.lang.String getCustom2()
```
    Returns:
    
    Returns the custom2.
  - setCustom2
```
void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - The custom2 to set.
  - getCustom3
```
java.lang.String getCustom3()
```
    Returns:
    
    Returns the custom3.
  - setCustom3
```
void setCustom3(java.lang.String custom3)
```
    Parameters:
    
    custom3 - The custom3 to set.
  - getCustom4
```
java.lang.String getCustom4()
```
    Returns:
    
    Returns the custom4.
  - setCustom4
```
void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - The custom4 to set.
  - getCustom5
```
java.lang.String getCustom5()
```
    Returns:
    
    Returns the custom5.
  - setCustom5
```
void setCustom5(java.lang.String custom5)
```
    Parameters:
    
    custom5 - The custom5 to set.
  - getCustom6
```
java.lang.String getCustom6()
```
    Returns:
    
    the custom6
  - setCustom6
```
void setCustom6(java.lang.String custom6)
```
    Parameters:
    
    custom6 - the custom6 to set
  - getCustom7
```
java.lang.String getCustom7()
```
    Returns:
    
    the custom7
  - setCustom7
```
void setCustom7(java.lang.String custom7)
```
    Parameters:
    
    custom7 - the custom7 to set
  - getCustom8
```
java.lang.String getCustom8()
```
    Returns:
    
    the custom8
  - setCustom8
```
void setCustom8(java.lang.String custom8)
```
    Parameters:
    
    custom8 - the custom8 to set
  - getCustom9
```
java.lang.String getCustom9()
```
    Returns:
    
    the custom9
  - setCustom9
```
void setCustom9(java.lang.String custom9)
```
    Parameters:
    
    custom9 - the custom9 to set
  - getCustom10
```
java.lang.String getCustom10()
```
    Returns:
    
    the custom10
  - setCustom10
```
void setCustom10(java.lang.String custom10)
```
    Parameters:
    
    custom10 - the custom10 to set
  - getCustom11
```
java.lang.String getCustom11()
```
    Returns:
    
    the custom11
  - setCustom11
```
void setCustom11(java.lang.String custom11)
```
    Parameters:
    
    custom11 - the custom11 to set
  - getCustom12
```
java.lang.String getCustom12()
```
    Returns:
    
    the custom12
  - setCustom12
```
void setCustom12(java.lang.String custom12)
```
    Parameters:
    
    custom12 - the custom12 to set
  - getCustom13
```
java.lang.String getCustom13()
```
    Returns:
    
    the custom13
  - setCustom13
```
void setCustom13(java.lang.String custom13)
```
    Parameters:
    
    custom13 - the custom13 to set
  - getCustom14
```
java.lang.String getCustom14()
```
    Returns:
    
    the custom14
  - setCustom14
```
void setCustom14(java.lang.String custom14)
```
    Parameters:
    
    custom14 - the custom14 to set
  - getCustom15
```
java.lang.String getCustom15()
```
    Returns:
    
    the custom15
  - setCustom15
```
void setCustom15(java.lang.String custom15)
```
    Parameters:
    
    custom15 - the custom15 to set
  - getCustom16
```
java.lang.String getCustom16()
```
    Returns:
    
    the custom16
  - setCustom16
```
void setCustom16(java.lang.String custom16)
```
    Parameters:
    
    custom16 - the custom16 to set
  - getCouponCode
```
java.lang.String getCouponCode()
```
    The coupon code used when checking out. Multiple coupons may be entered as a comma separated string.
    
    Returns:
    
    Returns the couponCode.
  - setCouponCode
```
void setCouponCode(java.lang.String couponCode)
```
    The coupon code used when checking out. Multiple coupons may be entered as a comma separated string.
    
    Parameters:
    
    couponCode - The couponCode to set.
  - getSubTotalExTax
```
java.math.BigDecimal getSubTotalExTax()
```
    Returns:
    
    Returns the subTotalExTax.
  - setSubTotalExTax
```
void setSubTotalExTax(java.math.BigDecimal subTotalExTax)
```
    Parameters:
    
    subTotalExTax - The subTotalExTax to set.
  - getSubTotalIncTax
```
java.math.BigDecimal getSubTotalIncTax()
```
    Returns:
    
    Returns the subTotalIncTax.
  - setSubTotalIncTax
```
void setSubTotalIncTax(java.math.BigDecimal subTotalIncTax)
```
    Parameters:
    
    subTotalIncTax - The subTotalIncTax to set.
  - getCouponIds
```
java.lang.String getCouponIds()
```
    A comma separated list of coupon ids.
    
    Returns:
    
    Returns the couponIds.
  - setCouponIds
```
void setCouponIds(java.lang.String couponIds)
```
    A comma separated list of coupon ids.
    
    Parameters:
    
    couponIds - The couponIds to set.
  - getPromotionIds
```
java.lang.String getPromotionIds()
```
    A comma separated list of promotion ids.
    
    Returns:
    
    Returns the promotionIds.
  - setPromotionIds
```
void setPromotionIds(java.lang.String promotionIds)
```
    A comma separated list of promotion ids.
    
    Parameters:
    
    promotionIds - The promotionIds to set.
  - getPaymentModuleCode
```
java.lang.String getPaymentModuleCode()
```
    The code of the payment module used for the order (e.g. cod, worldpay, paypal)
    
    Returns:
    
    Returns the paymentModuleCode.
  - setPaymentModuleCode
```
void setPaymentModuleCode(java.lang.String paymentModuleCode)
```
    The code of the payment module used for the order (e.g. cod, worldpay, paypal)
    
    Parameters:
    
    paymentModuleCode - The paymentModuleCode to set.
  - getPaymentModuleSubCode
```
java.lang.String getPaymentModuleSubCode()
```
    The payment sub-code (typically used when a payment module has multiple payment methods)
    
    Returns:
    
    the paymentModuleSubCode
  - setPaymentModuleSubCode
```
void setPaymentModuleSubCode(java.lang.String paymentModuleSubCode)
```
    The payment sub-code (typically used when a payment module has multiple payment methods)
    
    Parameters:
    
    paymentModuleSubCode - the paymentModuleSubCode to set
  - getShippingModuleCode
```
java.lang.String getShippingModuleCode()
```
    The code of the shipping module used for the order (i.e. flat, free, ups)
    
    Returns:
    
    Returns the shippingModuleCode.
  - setShippingModuleCode
```
void setShippingModuleCode(java.lang.String shippingModuleCode)
```
    The code of the shipping module used for the order (i.e. flat, free, ups)
    
    Parameters:
    
    shippingModuleCode - The shippingModuleCode to set.
  - getOrderNumber
```
java.lang.String getOrderNumber()
```
    The order number of the order
    
    Returns:
    
    Returns the orderNumber.
  - setOrderNumber
```
void setOrderNumber(java.lang.String orderNumber)
```
    The order number of the order
    
    Parameters:
    
    orderNumber - The orderNumber to set.
  - getLifecycleId
```
java.lang.String getLifecycleId()
```
    Instantiated when the order is created. Can be used to identify the order even before it is saved, which is when the id and order number are created.
    
    Returns:
    
    the lifecycleId
  - setLifecycleId
```
void setLifecycleId(java.lang.String lifecycleId)
```
    Instantiated when the order is created. Can be used to identify the order even before it is saved, which is when the id and order number are created.
    
    Parameters:
    
    lifecycleId - the lifecycleId to set
  - getTrackingNumber
```
java.lang.String getTrackingNumber()
```
    The tracking number of the order.
    
    Returns:
    
    the trackingNumber
  - setTrackingNumber
```
void setTrackingNumber(java.lang.String trackingNumber)
```
    The tracking number of the order.
    
    Parameters:
    
    trackingNumber - the trackingNumber to set
  - getPointsRedeemed
```
int getPointsRedeemed()
```
    The number of Reward Points redeemed for the order
    
    Returns:
    
    the pointsRedeemed
  - setPointsRedeemed
```
void setPointsRedeemed(int pointsRedeemed)
```
    The number of Reward Points redeemed for the order
    
    Parameters:
    
    pointsRedeemed - the pointsRedeemed to set
  - getPointsAwarded
```
int getPointsAwarded()
```
    The number of Reward Points rewarded for the order
    
    Returns:
    
    the pointsAwarded
  - setPointsAwarded
```
void setPointsAwarded(int pointsAwarded)
```
    The number of Reward Points rewarded for the order
    
    Parameters:
    
    pointsAwarded - the pointsAwarded to set
  - getPointsReservationId
```
int getPointsReservationId()
```
    The numeric id of the points reserved for this order. If the order isn't confirmed and eventually canceled, the id can be used to return the points back to the customer.
    
    Returns:
    
    the pointsReservationId
  - setPointsReservationId
```
void setPointsReservationId(int pointsReservationId)
```
    The numeric id of the points reserved for this order. If the order isn't confirmed and eventually canceled, the id can be used to return the points back to the customer.
    
    Parameters:
    
    pointsReservationId - the pointsReservationId to set
  - getLocale
```
java.lang.String getLocale()
```
    Locale of the customer
    
    Returns:
    
    the locale
  - setLocale
```
void setLocale(java.lang.String locale)
```
    Locale of the customer
    
    Parameters:
    
    locale - the locale to set
  - getGiftCertCode
```
java.lang.String getGiftCertCode()
```
    The code of the gift certificate. Multiple gift certificates may be entered as a comma separated string.
    
    Returns:
    
    the giftCertCode
  - setGiftCertCode
```
void setGiftCertCode(java.lang.String giftCertCode)
```
    The code of the gift certificate. Multiple gift certificates may be entered as a comma separated string.
    
    Parameters:
    
    giftCertCode - the giftCertCode to set
  - getInvoiceFilename
```
java.lang.String getInvoiceFilename()
```
    The filename of the invoice (add this to the base URL or base directory path configuration parameters to get the full name)
    
    Returns:
    
    the invoice filename
  - setInvoiceFilename
```
void setInvoiceFilename(java.lang.String invoiceFilename)
```
    The filename of the invoice
    
    Parameters:
    
    invoiceFilename - the filename to set
  - getCcCVV
```
java.lang.String getCcCVV()
```
    Credit card ccCVV
    
    Returns:
    
    the ccCVV
  - setCcCVV
```
void setCcCVV(java.lang.String ccCVV)
```
    Credit card ccCVV
    
    Parameters:
    
    ccCVV - the ccCVV to set
  - getCustomerTelephone1
```
java.lang.String getCustomerTelephone1()
```
    Returns:
    
    the customerTelephone1
  - setCustomerTelephone1
```
void setCustomerTelephone1(java.lang.String customerTelephone1)
```
    Parameters:
    
    customerTelephone1 - the customerTelephone1 to set
  - getDeliveryTelephone
```
java.lang.String getDeliveryTelephone()
```
    Returns:
    
    the deliveryTelephone
  - setDeliveryTelephone
```
void setDeliveryTelephone(java.lang.String deliveryTelephone)
```
    Parameters:
    
    deliveryTelephone - the deliveryTelephone to set
  - getDeliveryTelephone1
```
java.lang.String getDeliveryTelephone1()
```
    Returns:
    
    the deliveryTelephone1
  - setDeliveryTelephone1
```
void setDeliveryTelephone1(java.lang.String deliveryTelephone1)
```
    Parameters:
    
    deliveryTelephone1 - the deliveryTelephone1 to set
  - getDeliveryEmail
```
java.lang.String getDeliveryEmail()
```
    Returns:
    
    the deliveryEmail
  - setDeliveryEmail
```
void setDeliveryEmail(java.lang.String deliveryEmail)
```
    Parameters:
    
    deliveryEmail - the deliveryEmail to set
  - getBillingTelephone
```
java.lang.String getBillingTelephone()
```
    Returns:
    
    the billingTelephone
  - setBillingTelephone
```
void setBillingTelephone(java.lang.String billingTelephone)
```
    Parameters:
    
    billingTelephone - the billingTelephone to set
  - getBillingTelephone1
```
java.lang.String getBillingTelephone1()
```
    Returns:
    
    the billingTelephone1
  - setBillingTelephone1
```
void setBillingTelephone1(java.lang.String billingTelephone1)
```
    Parameters:
    
    billingTelephone1 - the billingTelephone1 to set
  - getBillingEmail
```
java.lang.String getBillingEmail()
```
    Returns:
    
    the billingEmail
  - setBillingEmail
```
void setBillingEmail(java.lang.String billingEmail)
```
    Parameters:
    
    billingEmail - the billingEmail to set
  - getShippingServiceCode
```
java.lang.String getShippingServiceCode()
```
    Used for shipping modules such as UPS, FedEx etc. to keep track of which service code was selected by the customer.
    
    Returns:
    
    the shippingServiceCode
  - setShippingServiceCode
```
void setShippingServiceCode(java.lang.String shippingServiceCode)
```
    Used for shipping modules such as UPS, FedEx etc. to keep track of which service code was selected by the customer.
    
    Parameters:
    
    shippingServiceCode - the shippingServiceCode to set
  - getCreator
```
java.lang.String getCreator()
```
    Identifier of the administrator who created the order
    
    Returns:
    
    the creator
  - setCreator
```
void setCreator(java.lang.String creator)
```
    Identifier of the administrator who created the order
    
    Parameters:
    
    creator - the creator to set
  - getAffiliateId
```
java.lang.String getAffiliateId()
```
    Id of affiliate partner
    
    Returns:
    
    the affiliateId
  - setAffiliateId
```
void setAffiliateId(java.lang.String affiliateId)
```
    Id of affiliate partner
    
    Parameters:
    
    affiliateId - the affiliateId to set
  - getVendorOrders
```
OrderIf[] getVendorOrders()
```
    When in multi-vendor mode, the array contains orders for each individual vendor
    
    Returns:
    
    the vendorOrders
  - setVendorOrders
```
void setVendorOrders(OrderIf[] vendorOrders)
```
    When in multi-vendor mode, the array contains orders for each individual vendor
    
    Parameters:
    
    vendorOrders - the vendorOrders to set
  - getParentId
```
int getParentId()
```
    Id of the parent order used when in multi-vendor mode
    
    Returns:
    
    the parentId
  - setParentId
```
void setParentId(int parentId)
```
    Id of the parent order used when in multi-vendor mode
    
    Parameters:
    
    parentId - the parentId to set
  - getStoreId
```
java.lang.String getStoreId()
```
    Id of the store that the order belongs to.
    
    Returns:
    
    the storeId
  - setStoreId
```
void setStoreId(java.lang.String storeId)
```
    Id of the store that the order belongs to.
    
    Parameters:
    
    storeId - the storeId to set
  - getStoreName
```
java.lang.String getStoreName()
```
    Name of the store that the order belongs to.
    
    Returns:
    
    the storeName
  - setStoreName
```
void setStoreName(java.lang.String storeName)
```
    Name of the store that the order belongs to
    
    Parameters:
    
    storeName - the storeName to set
  - getOrderShipments
```
OrderShipmentIf[] getOrderShipments()
```
    An array of objects containing shipment information
    
    Returns:
    
    the orderShipments
  - setOrderShipments
```
void setOrderShipments(OrderShipmentIf[] orderShipments)
```
    An array of objects containing shipment information
    
    Parameters:
    
    orderShipments - the orderShipments to set
  - getAvailableShippingQuotes
```
ShippingQuoteIf[] getAvailableShippingQuotes()
```
    The shipping quotes available for this order
    
    Returns:
    
    the availableShippingQuotes
  - setAvailableShippingQuotes
```
void setAvailableShippingQuotes(ShippingQuoteIf[] availableShippingQuotes)
```
    The shipping quotes available for this order
    
    Parameters:
    
    availableShippingQuotes - the availableShippingQuotes to set
  - getAvailablePaymentGateways
```
PaymentDetailsIf[] getAvailablePaymentGateways()
```
    The payment gateways available for the order
    
    Returns:
    
    the availablePaymentGateways
  - setAvailablePaymentGateways
```
void setAvailablePaymentGateways(PaymentDetailsIf[] availablePaymentGateways)
```
    The payment gateways available for the order
    
    Parameters:
    
    availablePaymentGateways - the availablePaymentGateways to set
  - getFilter1
```
java.lang.String getFilter1()
```
    Returns:
    
    the filter1
  - setFilter1
```
void setFilter1(java.lang.String filter1)
```
    Parameters:
    
    filter1 - the filter1 to set
  - getFilter2
```
java.lang.String getFilter2()
```
    Returns:
    
    the filter2
  - setFilter2
```
void setFilter2(java.lang.String filter2)
```
    Parameters:
    
    filter2 - the filter2 to set
  - getFilterDecimal1
```
java.math.BigDecimal getFilterDecimal1()
```
    Returns:
    
    the filterDecimal1
  - setFilterDecimal1
```
void setFilterDecimal1(java.math.BigDecimal filterDecimal1)
```
    Parameters:
    
    filterDecimal1 - the filterDecimal1 to set
  - getArchiveId
```
java.lang.String getArchiveId()
```
    Used to reference archived orders
    
    Returns:
    
    the archiveId
  - setArchiveId
```
void setArchiveId(java.lang.String archiveId)
```
    Used to reference archived orders
    
    Parameters:
    
    archiveId - the archiveId to set
  - getAdminDiscount
```
java.math.BigDecimal getAdminDiscount()
```
    Discount added by an admin user and picked up by a promotion module
    
    Returns:
    
    the adminDiscount
  - setAdminDiscount
```
void setAdminDiscount(java.math.BigDecimal adminDiscount)
```
    Discount added by an admin user and picked up by a promotion module
    
    Parameters:
    
    adminDiscount - the adminDiscount to set
  - getArchivedOrders
```
OrderIf[] getArchivedOrders()
```
    The archived orders of this order. Archived orders are created when an order is modified in order to save an audit trail.
    
    Returns:
    
    the archivedOrders
  - setArchivedOrders
```
void setArchivedOrders(OrderIf[] archivedOrders)
```
    The archived orders of this order. Archived orders are created when an order is modified in order to save an audit trail.
    
    Parameters:
    
    archivedOrders - the archivedOrders to set

Interface OrderIf

Method Summary

Method Detail

getBillingCity

setBillingCity

getBillingCompany

setBillingCompany

getBillingCountry

setBillingCountry

getBillingName

setBillingName

getBillingPostcode

setBillingPostcode

getBillingState

setBillingState

getBillingStreetAddress

setBillingStreetAddress

getBillingStreetAddress1

setBillingStreetAddress1

getBillingSuburb

setBillingSuburb

getCcExpires

setCcExpires

getCcNumber

setCcNumber

getCcOwner

setCcOwner

getCcType

setCcType

getCurrencyValue

setCurrencyValue

getCustomerCity

setCustomerCity

getCustomerCompany

setCustomerCompany

getCustomerCountry

setCustomerCountry

getCustomerEmail

setCustomerEmail

getCustomerName

setCustomerName

getCustomerPostcode

setCustomerPostcode

getCustomerState

setCustomerState

getCustomerStreetAddress

setCustomerStreetAddress

getCustomerStreetAddress1

setCustomerStreetAddress1

getCustomerSuburb

setCustomerSuburb

getCustomerTelephone

setCustomerTelephone

getDateFinished

setDateFinished

getDatePurchased

setDatePurchased

getDeliveryCity

setDeliveryCity

getDeliveryCompany

setDeliveryCompany

getDeliveryCountry

setDeliveryCountry

getDeliveryName

setDeliveryName

getDeliveryPostcode

setDeliveryPostcode

getDeliveryState

setDeliveryState

getDeliveryStreetAddress

setDeliveryStreetAddress

getDeliveryStreetAddress1

setDeliveryStreetAddress1

getDeliverySuburb

setDeliverySuburb

getId

setId

getLastModified

setLastModified

getPaymentMethod