com.konakart.appif
Interface OrderIf


public interface OrderIf

Contains all data required to describe an order for use within KonaKart.


Method Summary
 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 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 getBillingSuburb()
           
 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.
 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 getCustom2()
           
 java.lang.String getCustom3()
           
 java.lang.String getCustom4()
           
 java.lang.String getCustom5()
           
 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 getCustomerSuburb()
           
 java.lang.String getCustomerTelephone()
           
 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 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 getDeliverySuburb()
           
 ZoneIf getDeliveryZoneObject()
           
 int getId()
           
 java.util.Calendar getLastModified()
           
 int getNumProducts()
           
 OrderProductIf[] getOrderProducts()
          An array of OrderProduct objects which define the products contained within the order.
 OrderTotalIf[] getOrderTotals()
          An array of OrderTotal objects that contain information such as the sub total, the shipping, the discount and the total.
 PaymentDetailsIf getPaymentDetails()
           
 java.lang.String getPaymentMethod()
           
 java.lang.String getPaymentModuleCode()
          The code of the payment module used for the order (i.e.
 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()
           
 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.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()
           
 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 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 setBillingSuburb(java.lang.String billingSuburb)
           
 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 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 setCustom2(java.lang.String custom2)
           
 void setCustom3(java.lang.String custom3)
           
 void setCustom4(java.lang.String custom4)
           
 void setCustom5(java.lang.String custom5)
           
 void setCustomerAddrFormatId(int customerAddrFormatId)
          The id of the address format template used to format the customer address.
 void setCustomerAddrFormatTemplate(java.lang.String customerAddrFormatTemplate)
          The address format template for the customer address.
 void setCustomerAddrId(int customerAddrId)
           
 void setCustomerCity(java.lang.String customerCity)
           
 void setCustomerCompany(java.lang.String customerCompany)
           
 void setCustomerCountry(java.lang.String customerCountry)
           
 void setCustomerEmail(java.lang.String customerEmail)
           
 void setCustomerFormattedAddress(java.lang.String customerFormattedAddress)
          The formatted customer address which has been formatted using the address format template.
 void setCustomerId(int customerId)
           
 void setCustomerName(java.lang.String customerName)
           
 void setCustomerPostcode(java.lang.String customerPostcode)
           
 void setCustomerState(java.lang.String customerState)
           
 void setCustomerStreetAddress(java.lang.String customerStreetAddress)
           
 void setCustomerSuburb(java.lang.String customerSuburb)
           
 void setCustomerTelephone(java.lang.String customerTelephone)
           
 void setDateFinished(java.util.Calendar dateFinished)
           
 void setDatePurchased(java.util.Calendar datePurchased)
          The date that the order was saved.
 void setDeliveryAddrFormatId(int deliveryAddrFormatId)
          The id of the address format template used to format the delivery address.
 void setDeliveryAddrFormatTemplate(java.lang.String deliveryAddrFormatTemplate)
          The address format template for the delivery address.
 void setDeliveryAddrId(int deliveryAddrId)
           
 void setDeliveryCity(java.lang.String deliveryCity)
           
 void setDeliveryCompany(java.lang.String deliveryCompany)
           
 void setDeliveryCountry(java.lang.String deliveryCountry)
           
 void setDeliveryCountryObject(CountryIf deliveryCountryObject)
           
 void 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 setDeliverySuburb(java.lang.String deliverySuburb)
           
 void setDeliveryZoneObject(ZoneIf deliveryZoneObject)
           
 void setId(int id)
           
 void setLastModified(java.util.Calendar lastModified)
           
 void setNumProducts(int numProducts)
           
 void setOrderProducts(OrderProductIf[] orderProducts)
          An array of OrderProduct objects which define the products contained within the order.
 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 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 (i.e.
 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 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 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)
           
 

Method Detail

getBillingCity

java.lang.String getBillingCity()
Returns:
Returns the billingCity.

setBillingCity

void setBillingCity(java.lang.String billingCity)
Parameters:
billingCity - The billingCity to set.

getBillingCompany

java.lang.String getBillingCompany()
Returns:
Returns the billingCompany.

setBillingCompany

void setBillingCompany(java.lang.String billingCompany)
Parameters:
billingCompany - The billingCompany to set.

getBillingCountry

java.lang.String getBillingCountry()
Returns:
Returns the billingCountry.

setBillingCountry

void setBillingCountry(java.lang.String billingCountry)
Parameters:
billingCountry - The billingCountry to set.

getBillingName

java.lang.String getBillingName()
Returns:
Returns the billingName.

setBillingName

void setBillingName(java.lang.String billingName)
Parameters:
billingName - The billingName to set.

getBillingPostcode

java.lang.String getBillingPostcode()
Returns:
Returns the billingPostcode.

setBillingPostcode

void setBillingPostcode(java.lang.String billingPostcode)
Parameters:
billingPostcode - The billingPostcode to set.

getBillingState

java.lang.String getBillingState()
Returns:
Returns the billingState.

setBillingState

void setBillingState(java.lang.String billingState)
Parameters:
billingState - The billingState to set.

getBillingStreetAddress

java.lang.String getBillingStreetAddress()
Returns:
Returns the billingStreetAddress.

setBillingStreetAddress

void setBillingStreetAddress(java.lang.String billingStreetAddress)
Parameters:
billingStreetAddress - The billingStreetAddress to set.

getBillingSuburb

java.lang.String getBillingSuburb()
Returns:
Returns the billingSuburb.

setBillingSuburb

void setBillingSuburb(java.lang.String billingSuburb)
Parameters:
billingSuburb - The billingSuburb to set.

getCcExpires

java.lang.String getCcExpires()
Returns:
Returns the ccExpires.

setCcExpires

void setCcExpires(java.lang.String ccExpires)
Parameters:
ccExpires - The ccExpires to set.

getCcNumber

java.lang.String getCcNumber()
Returns:
Returns the ccNumber.

setCcNumber

void setCcNumber(java.lang.String ccNumber)
Parameters:
ccNumber - The ccNumber to set.

getCcOwner

java.lang.String getCcOwner()
Returns:
Returns the ccOwner.

setCcOwner

void setCcOwner(java.lang.String ccOwner)
Parameters:
ccOwner - The ccOwner to set.

getCcType

java.lang.String getCcType()
Returns:
Returns the ccType.

setCcType

void setCcType(java.lang.String ccType)
Parameters:
ccType - The ccType to set.

getCurrencyValue

java.math.BigDecimal getCurrencyValue()
The exchange rate for the currency.

Returns:
Returns the currencyValue.

setCurrencyValue

void setCurrencyValue(java.math.BigDecimal currencyValue)
The exchange rate for the currency.

Parameters:
currencyValue - The currencyValue to set.

getCustomerCity

java.lang.String getCustomerCity()
Returns:
Returns the customerCity.

setCustomerCity

void setCustomerCity(java.lang.String customerCity)
Parameters:
customerCity - The customerCity to set.

getCustomerCompany

java.lang.String getCustomerCompany()
Returns:
Returns the customerCompany.

setCustomerCompany

void setCustomerCompany(java.lang.String customerCompany)
Parameters:
customerCompany - The customerCompany to set.

getCustomerCountry

java.lang.String getCustomerCountry()
Returns:
Returns the customerCountry.

setCustomerCountry

void setCustomerCountry(java.lang.String customerCountry)
Parameters:
customerCountry - The customerCountry to set.

getCustomerEmail

java.lang.String getCustomerEmail()
Returns:
Returns the customerEmail.

setCustomerEmail

void setCustomerEmail(java.lang.String customerEmail)
Parameters:
customerEmail - The customerEmail to set.

getCustomerName

java.lang.String getCustomerName()
Returns:
Returns the customerName.

setCustomerName

void setCustomerName(java.lang.String customerName)
Parameters:
customerName - The customerName to set.

getCustomerPostcode

java.lang.String getCustomerPostcode()
Returns:
Returns the customerPostcode.

setCustomerPostcode

void setCustomerPostcode(java.lang.String customerPostcode)
Parameters:
customerPostcode - The customerPostcode to set.

getCustomerState

java.lang.String getCustomerState()
Returns:
Returns the customerState.

setCustomerState

void setCustomerState(java.lang.String customerState)
Parameters:
customerState - The customerState to set.

getCustomerStreetAddress

java.lang.String getCustomerStreetAddress()
Returns:
Returns the customerStreetAddress.

setCustomerStreetAddress

void setCustomerStreetAddress(java.lang.String customerStreetAddress)
Parameters:
customerStreetAddress - The customerStreetAddress to set.

getCustomerSuburb

java.lang.String getCustomerSuburb()
Returns:
Returns the customerSuburb.

setCustomerSuburb

void setCustomerSuburb(java.lang.String customerSuburb)
Parameters:
customerSuburb - The customerSuburb to set.

getCustomerTelephone

java.lang.String getCustomerTelephone()
Returns:
Returns the customerTelephone.

setCustomerTelephone

void setCustomerTelephone(java.lang.String customerTelephone)
Parameters:
customerTelephone - The customerTelephone to set.

getDateFinished

java.util.Calendar getDateFinished()
Returns:
Returns the dateFinished.

setDateFinished

void setDateFinished(java.util.Calendar dateFinished)
Parameters:
dateFinished - The dateFinished to set.

getDatePurchased

java.util.Calendar getDatePurchased()
The date that the order was saved.

Returns:
Returns the datePurchased.

setDatePurchased

void setDatePurchased(java.util.Calendar datePurchased)
The date that the order was saved.

Parameters:
datePurchased - The datePurchased to set.

getDeliveryCity

java.lang.String getDeliveryCity()
Returns:
Returns the deliveryCity.

setDeliveryCity

void setDeliveryCity(java.lang.String deliveryCity)
Parameters:
deliveryCity - The deliveryCity to set.

getDeliveryCompany

java.lang.String getDeliveryCompany()
Returns:
Returns the deliveryCompany.

setDeliveryCompany

void setDeliveryCompany(java.lang.String deliveryCompany)
Parameters:
deliveryCompany - The deliveryCompany to set.

getDeliveryCountry

java.lang.String getDeliveryCountry()
Returns:
Returns the deliveryCountry.

setDeliveryCountry

void setDeliveryCountry(java.lang.String deliveryCountry)
Parameters:
deliveryCountry - The deliveryCountry to set.

getDeliveryName

java.lang.String getDeliveryName()
Returns:
Returns the deliveryName.

setDeliveryName

void setDeliveryName(java.lang.String deliveryName)
Parameters:
deliveryName - The deliveryName to set.

getDeliveryPostcode

java.lang.String getDeliveryPostcode()
Returns:
Returns the deliveryPostcode.

setDeliveryPostcode

void setDeliveryPostcode(java.lang.String deliveryPostcode)
Parameters:
deliveryPostcode - The deliveryPostcode to set.

getDeliveryState

java.lang.String getDeliveryState()
Returns:
Returns the deliveryState.

setDeliveryState

void setDeliveryState(java.lang.String deliveryState)
Parameters:
deliveryState - The deliveryState to set.

getDeliveryStreetAddress

java.lang.String getDeliveryStreetAddress()
Returns:
Returns the deliveryStreetAddress.

setDeliveryStreetAddress

void setDeliveryStreetAddress(java.lang.String deliveryStreetAddress)
Parameters:
deliveryStreetAddress - The deliveryStreetAddress to set.

getDeliverySuburb

java.lang.String getDeliverySuburb()
Returns:
Returns the deliverySuburb.

setDeliverySuburb

void setDeliverySuburb(java.lang.String deliverySuburb)
Parameters:
deliverySuburb - The deliverySuburb to set.

getId

int getId()
Returns:
Returns the id.

setId

void setId(int id)
Parameters:
id - The id to set.

getLastModified

java.util.Calendar getLastModified()
Returns:
Returns the lastModified.

setLastModified

void setLastModified(java.util.Calendar lastModified)
Parameters:
lastModified - The lastModified to set.

getPaymentMethod

java.lang.String getPaymentMethod()
Returns:
Returns the paymentMethod.

setPaymentMethod

void setPaymentMethod(java.lang.String paymentMethod)
Parameters:
paymentMethod - The paymentMethod to set.

getShippingMethod

java.lang.String getShippingMethod()
This virtual attribute is set by retrieving the shipping method from the "ot_shipping" order total object.

Returns:
Returns the shippingMethod.

setShippingMethod

void setShippingMethod(java.lang.String shippingMethod)
Parameters:
shippingMethod - The shippingMethod to set.

getStatus

int getStatus()
The current integer status id. The orders_status table contains a description of this status id.

Returns:
Returns the status.

setStatus

void setStatus(int status)
The current integer status id. The orders_status table contains a description of this status id.

Parameters:
status - The status to set.

getCustomerId

int getCustomerId()
Returns:
Returns the customerId.

setCustomerId

void setCustomerId(int customerId)
Parameters:
customerId - The customerId to set.

getBillingAddrFormatId

int getBillingAddrFormatId()
The id of the address format template used to format the billing address.

Returns:
Returns the billingAddrFormatId.

setBillingAddrFormatId

void setBillingAddrFormatId(int billingAddrFormatId)
The id of the address format template used to format the billing address.

Parameters:
billingAddrFormatId - The billingAddrFormatId to set.

getCustomerAddrFormatId

int getCustomerAddrFormatId()
The id of the address format template used to format the customer address.

Returns:
Returns the customerAddrFormatId.

setCustomerAddrFormatId

void setCustomerAddrFormatId(int customerAddrFormatId)
The id of the address format template used to format the customer address.

Parameters:
customerAddrFormatId - The customerAddrFormatId to set.

getDeliveryAddrFormatId

int getDeliveryAddrFormatId()
The id of the address format template used to format the delivery address.

Returns:
Returns the deliveryAddrFormatId.

setDeliveryAddrFormatId

void setDeliveryAddrFormatId(int deliveryAddrFormatId)
The id of the address format template used to format the delivery address.

Parameters:
deliveryAddrFormatId - The deliveryAddrFormatId to set.

getOrderProducts

OrderProductIf[] getOrderProducts()
An array of OrderProduct objects which define the products contained within the order.

Returns:
Returns the orderProducts.

setOrderProducts

void setOrderProducts(OrderProductIf[] orderProducts)
An array of OrderProduct objects which define the products contained within the order.

Parameters:
orderProducts - The orderProducts to set.

getBillingFormattedAddress

java.lang.String getBillingFormattedAddress()
The formatted billing address which has been formatted using the address format template.

Returns:
Returns the billingFormattedAddress.

setBillingFormattedAddress

void setBillingFormattedAddress(java.lang.String billingFormattedAddress)
The formatted billing address which has been formatted using the address format template.

Parameters:
billingFormattedAddress - The billingFormattedAddress to set.

getCustomerFormattedAddress

java.lang.String getCustomerFormattedAddress()
The formatted customer address which has been formatted using the address format template.

Returns:
Returns the customerFormattedAddress.

setCustomerFormattedAddress

void setCustomerFormattedAddress(java.lang.String customerFormattedAddress)
The formatted customer address which has been formatted using the address format template.

Parameters:
customerFormattedAddress - The customerFormattedAddress to set.

getDeliveryFormattedAddress

java.lang.String getDeliveryFormattedAddress()
The formatted delivery address which has been formatted using the address format template.

Returns:
Returns the deliveryFormattedAddress.

setDeliveryFormattedAddress

void setDeliveryFormattedAddress(java.lang.String deliveryFormattedAddress)
The formatted delivery address which has been formatted using the address format template.

Parameters:
deliveryFormattedAddress - The deliveryFormattedAddress to set.

getStatusText

java.lang.String getStatusText()
Text explaining the status.

Returns:
Returns the statusText.

setStatusText

void setStatusText(java.lang.String statusText)
Text explaining the status.

Parameters:
statusText - The statusText to set.

getTax

java.math.BigDecimal getTax()
Returns:
Returns the tax.

setTax

void setTax(java.math.BigDecimal tax)
Parameters:
tax - The tax to set.

getNumProducts

int getNumProducts()
Returns:
Returns the numProducts.

setNumProducts

void setNumProducts(int numProducts)
Parameters:
numProducts - The numProducts to set.

getBillingAddrFormatTemplate

java.lang.String getBillingAddrFormatTemplate()
The address format template for the billing address.

Returns:
Returns the billingAddrFormatTemplate.

setBillingAddrFormatTemplate

void setBillingAddrFormatTemplate(java.lang.String billingAddrFormatTemplate)
The address format template for the billing address.

Parameters:
billingAddrFormatTemplate - The billingAddrFormatTemplate to set.

getCustomerAddrFormatTemplate

java.lang.String getCustomerAddrFormatTemplate()
The address format template for the customer address.

Returns:
Returns the customerAddrFormatTemplate.

setCustomerAddrFormatTemplate

void setCustomerAddrFormatTemplate(java.lang.String customerAddrFormatTemplate)
The address format template for the customer address.

Parameters:
customerAddrFormatTemplate - The customerAddrFormatTemplate to set.

getDeliveryAddrFormatTemplate

java.lang.String getDeliveryAddrFormatTemplate()
The address format template for the delivery address.

Returns:
Returns the deliveryAddrFormatTemplate.

setDeliveryAddrFormatTemplate

void setDeliveryAddrFormatTemplate(java.lang.String deliveryAddrFormatTemplate)
The address format template for the delivery address.

Parameters:
deliveryAddrFormatTemplate - The deliveryAddrFormatTemplate to set.

getOrderTotals

OrderTotalIf[] getOrderTotals()
An array of OrderTotal objects that contain information such as the sub total, the shipping, the discount and the total.

Returns:
Returns the orderTotals.

setOrderTotals

void setOrderTotals(OrderTotalIf[] orderTotals)
An array of OrderTotal objects that contain information such as the sub total, the shipping, the discount and the total.

Parameters:
orderTotals - The orderTotals to set.

getStatusTrail

OrderStatusHistoryIf[] getStatusTrail()
An array of OrderStatusHistory objects used to keep track of all status changes during the life cycle of the order.

Returns:
Returns the statusTrail.

setStatusTrail

void setStatusTrail(OrderStatusHistoryIf[] statusTrail)
An array of OrderStatusHistory objects used to keep track of all status changes during the life cycle of the order.

Parameters:
statusTrail - The statusTrail to set.

getBillingAddrId

int getBillingAddrId()
Returns:
Returns the billingAddrId.

setBillingAddrId

void setBillingAddrId(int billingAddrId)
Parameters:
billingAddrId - The billingAddrId to set.

getCustomerAddrId

int getCustomerAddrId()
Returns:
Returns the customerAddrId.

setCustomerAddrId

void setCustomerAddrId(int customerAddrId)
Parameters:
customerAddrId - The customerAddrId to set.

getDeliveryAddrId

int getDeliveryAddrId()
Returns:
Returns the deliveryAddrId.

setDeliveryAddrId

void setDeliveryAddrId(int deliveryAddrId)
Parameters:
deliveryAddrId - The deliveryAddrId to set.

getDeliveryCountryObject

CountryIf getDeliveryCountryObject()
Returns:
Returns the deliveryCountryObject.

setDeliveryCountryObject

void setDeliveryCountryObject(CountryIf deliveryCountryObject)
Parameters:
deliveryCountryObject - The deliveryCountryObject to set.

getDeliveryZoneObject

ZoneIf getDeliveryZoneObject()
Returns:
Returns the deliveryZoneObject.

setDeliveryZoneObject

void setDeliveryZoneObject(ZoneIf deliveryZoneObject)
Parameters:
deliveryZoneObject - The deliveryZoneObject to set.

getTotalExTax

java.math.BigDecimal getTotalExTax()
Returns:
Returns the totalExTax.

setTotalExTax

void setTotalExTax(java.math.BigDecimal totalExTax)
Parameters:
totalExTax - The totalExTax to set.

getTotalIncTax

java.math.BigDecimal getTotalIncTax()
Returns:
Returns the totalIncTax.

setTotalIncTax

void setTotalIncTax(java.math.BigDecimal totalIncTax)
Parameters:
totalIncTax - The totalIncTax to set.

getShippingQuote

ShippingQuoteIf getShippingQuote()
Returns:
Returns the shippingQuote.

setShippingQuote

void setShippingQuote(ShippingQuoteIf shippingQuote)
Parameters:
shippingQuote - The shippingQuote to set.

getCurrencyCode

java.lang.String getCurrencyCode()
The three letter currency code. e.g. USD

Returns:
Returns the currencyCode.

setCurrencyCode

void setCurrencyCode(java.lang.String currencyCode)
The three letter currency code. e.g. USD

Parameters:
currencyCode - The currencyCode to set.

getCurrency

CurrencyIf getCurrency()
Returns:
Returns the currency.

setCurrency

void setCurrency(CurrencyIf currency)
Parameters:
currency - The currency to set.

getTaxRateObjectArray

TaxRateIf[] getTaxRateObjectArray()
The order may be subject to multiple tax rates which are compounded.

Returns:
Returns the taxRateObjectArray.

setTaxRateObjectArray

void setTaxRateObjectArray(TaxRateIf[] taxRateObjectArray)
The order may be subject to multiple tax rates which are compounded.

Parameters:
taxRateObjectArray - The taxRateObjectArray to set.

getPaymentDetails

PaymentDetailsIf getPaymentDetails()
Returns:
Returns the paymentDetails.

setPaymentDetails

void setPaymentDetails(PaymentDetailsIf paymentDetails)
Parameters:
paymentDetails - The paymentDetails to set.

getCustom1

java.lang.String getCustom1()
Returns:
Returns the custom1.

setCustom1

void setCustom1(java.lang.String custom1)
Parameters:
custom1 - The custom1 to set.

getCustom2

java.lang.String getCustom2()
Returns:
Returns the custom2.

setCustom2

void setCustom2(java.lang.String custom2)
Parameters:
custom2 - The custom2 to set.

getCustom3

java.lang.String getCustom3()
Returns:
Returns the custom3.

setCustom3

void setCustom3(java.lang.String custom3)
Parameters:
custom3 - The custom3 to set.

getCustom4

java.lang.String getCustom4()
Returns:
Returns the custom4.

setCustom4

void setCustom4(java.lang.String custom4)
Parameters:
custom4 - The custom4 to set.

getCustom5

java.lang.String getCustom5()
Returns:
Returns the custom5.

setCustom5

void setCustom5(java.lang.String custom5)
Parameters:
custom5 - The custom5 to set.

getCouponCode

java.lang.String getCouponCode()
The coupon code used when checking out.

Returns:
Returns the couponCode.

setCouponCode

void setCouponCode(java.lang.String couponCode)
The coupon code used when checking out.

Parameters:
couponCode - The couponCode to set.

getSubTotalExTax

java.math.BigDecimal getSubTotalExTax()
Returns:
Returns the subTotalExTax.

setSubTotalExTax

void setSubTotalExTax(java.math.BigDecimal subTotalExTax)
Parameters:
subTotalExTax - The subTotalExTax to set.

getSubTotalIncTax

java.math.BigDecimal getSubTotalIncTax()
Returns:
Returns the subTotalIncTax.

setSubTotalIncTax

void setSubTotalIncTax(java.math.BigDecimal subTotalIncTax)
Parameters:
subTotalIncTax - The subTotalIncTax to set.

getCouponIds

java.lang.String getCouponIds()
A comma separated list of coupon ids.

Returns:
Returns the couponIds.

setCouponIds

void setCouponIds(java.lang.String couponIds)
A comma separated list of coupon ids.

Parameters:
couponIds - The couponIds to set.

getPromotionIds

java.lang.String getPromotionIds()
A comma separated list of promotion ids.

Returns:
Returns the promotionIds.

setPromotionIds

void setPromotionIds(java.lang.String promotionIds)
A comma separated list of promotion ids.

Parameters:
promotionIds - The promotionIds to set.

getPaymentModuleCode

java.lang.String getPaymentModuleCode()
The code of the payment module used for the order (i.e. cod, worldpay, paypal)

Returns:
Returns the paymentModuleCode.

setPaymentModuleCode

void setPaymentModuleCode(java.lang.String paymentModuleCode)
The code of the payment module used for the order (i.e. cod, worldpay, paypal)

Parameters:
paymentModuleCode - The paymentModuleCode to set.

getShippingModuleCode

java.lang.String getShippingModuleCode()
The code of the shipping module used for the order (i.e. flat, free, ups)

Returns:
Returns the shippingModuleCode.

setShippingModuleCode

void setShippingModuleCode(java.lang.String shippingModuleCode)
The code of the shipping module used for the order (i.e. flat, free, ups)

Parameters:
shippingModuleCode - The shippingModuleCode to set.


Copyright © 2006 DS Data Systems UK Ltd.