|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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 |
|---|
java.lang.String getBillingCity()
void setBillingCity(java.lang.String billingCity)
billingCity - The billingCity to set.java.lang.String getBillingCompany()
void setBillingCompany(java.lang.String billingCompany)
billingCompany - The billingCompany to set.java.lang.String getBillingCountry()
void setBillingCountry(java.lang.String billingCountry)
billingCountry - The billingCountry to set.java.lang.String getBillingName()
void setBillingName(java.lang.String billingName)
billingName - The billingName to set.java.lang.String getBillingPostcode()
void setBillingPostcode(java.lang.String billingPostcode)
billingPostcode - The billingPostcode to set.java.lang.String getBillingState()
void setBillingState(java.lang.String billingState)
billingState - The billingState to set.java.lang.String getBillingStreetAddress()
void setBillingStreetAddress(java.lang.String billingStreetAddress)
billingStreetAddress - The billingStreetAddress to set.java.lang.String getBillingSuburb()
void setBillingSuburb(java.lang.String billingSuburb)
billingSuburb - The billingSuburb to set.java.lang.String getCcExpires()
void setCcExpires(java.lang.String ccExpires)
ccExpires - The ccExpires to set.java.lang.String getCcNumber()
void setCcNumber(java.lang.String ccNumber)
ccNumber - The ccNumber to set.java.lang.String getCcOwner()
void setCcOwner(java.lang.String ccOwner)
ccOwner - The ccOwner to set.java.lang.String getCcType()
void setCcType(java.lang.String ccType)
ccType - The ccType to set.java.math.BigDecimal getCurrencyValue()
void setCurrencyValue(java.math.BigDecimal currencyValue)
currencyValue - The currencyValue to set.java.lang.String getCustomerCity()
void setCustomerCity(java.lang.String customerCity)
customerCity - The customerCity to set.java.lang.String getCustomerCompany()
void setCustomerCompany(java.lang.String customerCompany)
customerCompany - The customerCompany to set.java.lang.String getCustomerCountry()
void setCustomerCountry(java.lang.String customerCountry)
customerCountry - The customerCountry to set.java.lang.String getCustomerEmail()
void setCustomerEmail(java.lang.String customerEmail)
customerEmail - The customerEmail to set.java.lang.String getCustomerName()
void setCustomerName(java.lang.String customerName)
customerName - The customerName to set.java.lang.String getCustomerPostcode()
void setCustomerPostcode(java.lang.String customerPostcode)
customerPostcode - The customerPostcode to set.java.lang.String getCustomerState()
void setCustomerState(java.lang.String customerState)
customerState - The customerState to set.java.lang.String getCustomerStreetAddress()
void setCustomerStreetAddress(java.lang.String customerStreetAddress)
customerStreetAddress - The customerStreetAddress to set.java.lang.String getCustomerSuburb()
void setCustomerSuburb(java.lang.String customerSuburb)
customerSuburb - The customerSuburb to set.java.lang.String getCustomerTelephone()
void setCustomerTelephone(java.lang.String customerTelephone)
customerTelephone - The customerTelephone to set.java.util.Calendar getDateFinished()
void setDateFinished(java.util.Calendar dateFinished)
dateFinished - The dateFinished to set.java.util.Calendar getDatePurchased()
void setDatePurchased(java.util.Calendar datePurchased)
datePurchased - The datePurchased to set.java.lang.String getDeliveryCity()
void setDeliveryCity(java.lang.String deliveryCity)
deliveryCity - The deliveryCity to set.java.lang.String getDeliveryCompany()
void setDeliveryCompany(java.lang.String deliveryCompany)
deliveryCompany - The deliveryCompany to set.java.lang.String getDeliveryCountry()
void setDeliveryCountry(java.lang.String deliveryCountry)
deliveryCountry - The deliveryCountry to set.java.lang.String getDeliveryName()
void setDeliveryName(java.lang.String deliveryName)
deliveryName - The deliveryName to set.java.lang.String getDeliveryPostcode()
void setDeliveryPostcode(java.lang.String deliveryPostcode)
deliveryPostcode - The deliveryPostcode to set.java.lang.String getDeliveryState()
void setDeliveryState(java.lang.String deliveryState)
deliveryState - The deliveryState to set.java.lang.String getDeliveryStreetAddress()
void setDeliveryStreetAddress(java.lang.String deliveryStreetAddress)
deliveryStreetAddress - The deliveryStreetAddress to set.java.lang.String getDeliverySuburb()
void setDeliverySuburb(java.lang.String deliverySuburb)
deliverySuburb - The deliverySuburb to set.int getId()
void setId(int id)
id - The id to set.java.util.Calendar getLastModified()
void setLastModified(java.util.Calendar lastModified)
lastModified - The lastModified to set.java.lang.String getPaymentMethod()
void setPaymentMethod(java.lang.String paymentMethod)
paymentMethod - The paymentMethod to set.java.lang.String getShippingMethod()
void setShippingMethod(java.lang.String shippingMethod)
shippingMethod - The shippingMethod to set.int getStatus()
void setStatus(int status)
status - The status to set.int getCustomerId()
void setCustomerId(int customerId)
customerId - The customerId to set.int getBillingAddrFormatId()
void setBillingAddrFormatId(int billingAddrFormatId)
billingAddrFormatId - The billingAddrFormatId to set.int getCustomerAddrFormatId()
void setCustomerAddrFormatId(int customerAddrFormatId)
customerAddrFormatId - The customerAddrFormatId to set.int getDeliveryAddrFormatId()
void setDeliveryAddrFormatId(int deliveryAddrFormatId)
deliveryAddrFormatId - The deliveryAddrFormatId to set.OrderProductIf[] getOrderProducts()
void setOrderProducts(OrderProductIf[] orderProducts)
orderProducts - The orderProducts to set.java.lang.String getBillingFormattedAddress()
void setBillingFormattedAddress(java.lang.String billingFormattedAddress)
billingFormattedAddress - The billingFormattedAddress to set.java.lang.String getCustomerFormattedAddress()
void setCustomerFormattedAddress(java.lang.String customerFormattedAddress)
customerFormattedAddress - The customerFormattedAddress to set.java.lang.String getDeliveryFormattedAddress()
void setDeliveryFormattedAddress(java.lang.String deliveryFormattedAddress)
deliveryFormattedAddress - The deliveryFormattedAddress to set.java.lang.String getStatusText()
void setStatusText(java.lang.String statusText)
statusText - The statusText to set.java.math.BigDecimal getTax()
void setTax(java.math.BigDecimal tax)
tax - The tax to set.int getNumProducts()
void setNumProducts(int numProducts)
numProducts - The numProducts to set.java.lang.String getBillingAddrFormatTemplate()
void setBillingAddrFormatTemplate(java.lang.String billingAddrFormatTemplate)
billingAddrFormatTemplate - The billingAddrFormatTemplate to set.java.lang.String getCustomerAddrFormatTemplate()
void setCustomerAddrFormatTemplate(java.lang.String customerAddrFormatTemplate)
customerAddrFormatTemplate - The customerAddrFormatTemplate to set.java.lang.String getDeliveryAddrFormatTemplate()
void setDeliveryAddrFormatTemplate(java.lang.String deliveryAddrFormatTemplate)
deliveryAddrFormatTemplate - The deliveryAddrFormatTemplate to set.OrderTotalIf[] getOrderTotals()
void setOrderTotals(OrderTotalIf[] orderTotals)
orderTotals - The orderTotals to set.OrderStatusHistoryIf[] getStatusTrail()
void setStatusTrail(OrderStatusHistoryIf[] statusTrail)
statusTrail - The statusTrail to set.int getBillingAddrId()
void setBillingAddrId(int billingAddrId)
billingAddrId - The billingAddrId to set.int getCustomerAddrId()
void setCustomerAddrId(int customerAddrId)
customerAddrId - The customerAddrId to set.int getDeliveryAddrId()
void setDeliveryAddrId(int deliveryAddrId)
deliveryAddrId - The deliveryAddrId to set.CountryIf getDeliveryCountryObject()
void setDeliveryCountryObject(CountryIf deliveryCountryObject)
deliveryCountryObject - The deliveryCountryObject to set.ZoneIf getDeliveryZoneObject()
void setDeliveryZoneObject(ZoneIf deliveryZoneObject)
deliveryZoneObject - The deliveryZoneObject to set.java.math.BigDecimal getTotalExTax()
void setTotalExTax(java.math.BigDecimal totalExTax)
totalExTax - The totalExTax to set.java.math.BigDecimal getTotalIncTax()
void setTotalIncTax(java.math.BigDecimal totalIncTax)
totalIncTax - The totalIncTax to set.ShippingQuoteIf getShippingQuote()
void setShippingQuote(ShippingQuoteIf shippingQuote)
shippingQuote - The shippingQuote to set.java.lang.String getCurrencyCode()
void setCurrencyCode(java.lang.String currencyCode)
currencyCode - The currencyCode to set.CurrencyIf getCurrency()
void setCurrency(CurrencyIf currency)
currency - The currency to set.TaxRateIf[] getTaxRateObjectArray()
void setTaxRateObjectArray(TaxRateIf[] taxRateObjectArray)
taxRateObjectArray - The taxRateObjectArray to set.PaymentDetailsIf getPaymentDetails()
void setPaymentDetails(PaymentDetailsIf paymentDetails)
paymentDetails - The paymentDetails to set.java.lang.String getCustom1()
void setCustom1(java.lang.String custom1)
custom1 - The custom1 to set.java.lang.String getCustom2()
void setCustom2(java.lang.String custom2)
custom2 - The custom2 to set.java.lang.String getCustom3()
void setCustom3(java.lang.String custom3)
custom3 - The custom3 to set.java.lang.String getCustom4()
void setCustom4(java.lang.String custom4)
custom4 - The custom4 to set.java.lang.String getCustom5()
void setCustom5(java.lang.String custom5)
custom5 - The custom5 to set.java.lang.String getCouponCode()
void setCouponCode(java.lang.String couponCode)
couponCode - The couponCode to set.java.math.BigDecimal getSubTotalExTax()
void setSubTotalExTax(java.math.BigDecimal subTotalExTax)
subTotalExTax - The subTotalExTax to set.java.math.BigDecimal getSubTotalIncTax()
void setSubTotalIncTax(java.math.BigDecimal subTotalIncTax)
subTotalIncTax - The subTotalIncTax to set.java.lang.String getCouponIds()
void setCouponIds(java.lang.String couponIds)
couponIds - The couponIds to set.java.lang.String getPromotionIds()
void setPromotionIds(java.lang.String promotionIds)
promotionIds - The promotionIds to set.java.lang.String getPaymentModuleCode()
void setPaymentModuleCode(java.lang.String paymentModuleCode)
paymentModuleCode - The paymentModuleCode to set.java.lang.String getShippingModuleCode()
void setShippingModuleCode(java.lang.String shippingModuleCode)
shippingModuleCode - The shippingModuleCode to set.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||