Order (KonaKart Server Engine API Documentation)

java.lang.Object
- com.konakart.app.Order

All Implemented Interfaces:: OrderIf

public class Order
extends java.lang.Object
implements OrderIf

Order

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`calculateShippingMethod()` The shipping method is retrieved from one of the OrderTotal records and the shippingMethod attribute is set.
`void`	`calculateTotals(int scale, int taxQuantityRule)` Sets the total, sub total, totalTax attributes.
`void`	`calculateTotals(int scale, int taxQuantityRule, boolean isEnhancedVariantHandlingModeEnabled)` Sets the total, sub total, totalTax attributes.
`void`	`createFormattedAddresses()` Based on the address templates, the formatted addresses are created.
`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`	`setAllAddresses(Address addr)` Set all of the addresses of the order (customer, delivery and billing) to the address contained in the address object parameter.
`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`	`setBillingAddress(Address addr)` Set the billing address to the address contained in the address object parameter.
`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`	`setCustomerAddress(Address addr)` Set the customer address to the address contained in the address object parameter.
`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`	`setCustomerDetails(Customer cust)` Populate the order with details from the customer.
`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`	`setDeliveryAddress(Address addr)` Set the delivery address to the address contained in the address object parameter.
`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`	`setManufacturerAddress(Address addr)` Set the manufacturer address to the address contained in the address object parameter.
`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
`java.lang.String`	`toString()`
`java.lang.String`	`toStringBrief()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Class Order

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Order

Order

Method Detail

toString

toStringBrief

calculateTotals

calculateTotals

setAllAddresses

createFormattedAddresses

setCustomerAddress

setDeliveryAddress

setBillingAddress

setManufacturerAddress

setCustomerDetails

calculateShippingMethod

getBillingCity

setBillingCity

getBillingCompany

setBillingCompany

getBillingCountry

setBillingCountry

getBillingName

setBillingName

getBillingPostcode

setBillingPostcode

getBillingState

setBillingState

getBillingStreetAddress

setBillingStreetAddress

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

getCustomerSuburb

setCustomerSuburb

getCustomerTelephone

setCustomerTelephone

getDateFinished

setDateFinished

getDatePurchased

setDatePurchased

getDeliveryCity

setDeliveryCity

getDeliveryCompany

setDeliveryCompany

getDeliveryCountry

setDeliveryCountry

getDeliveryName

setDeliveryName

getDeliveryPostcode

setDeliveryPostcode