com.konakart.rmi.app
Class S_Order

java.lang.Object
  com.konakart.rmi.app.S_Order

All Implemented Interfaces:

java.io.Serializable

public class S_Order
extends java.lang.Object
implements java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

S_Order()

Method Summary

java.lang.String	getAffiliateId() Id of affiliate partner
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
S_Currency	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	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()
S_Country	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()
S_Zone	getDeliveryZoneObject()
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
int	getNumProducts()
java.lang.String	getOrderNumber() The order number of the order
S_OrderProduct[]	getOrderProducts() An array of OrderProduct objects which define the products contained within the order.
S_OrderTotal[]	getOrderTotals() An array of OrderTotal objects that contain information such as the sub total, the shipping, the discount and the total.
S_PaymentDetails	getPaymentDetails()
java.lang.String	getPaymentMethod()
java.lang.String	getPaymentModuleCode() The code of the payment module used for the order (i.e.
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.
S_ShippingQuote	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.
S_OrderStatusHistory[]	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()
S_TaxRate[]	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.
void	setAffiliateId(java.lang.String _affiliateId) Id of affiliate partner
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(S_Currency _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	setCustomerStreetAddress1(java.lang.String _customerStreetAddress1)
void	setCustomerSuburb(java.lang.String _customerSuburb)
void	setCustomerTelephone(java.lang.String _customerTelephone)
void	setCustomerTelephone1(java.lang.String _customerTelephone1)
void	setDateFinished(java.util.Calendar _dateFinished)
void	setDatePurchased(java.util.Calendar _datePurchased) The date that the order was saved.
void	setDeliveryAddrFormatId(int _deliveryAddrFormatId) The id of the address format template used to format the delivery address.
void	setDeliveryAddrFormatTemplate(java.lang.String _deliveryAddrFormatTemplate) The address format template for the delivery address.
void	setDeliveryAddrId(int _deliveryAddrId)
void	setDeliveryCity(java.lang.String _deliveryCity)
void	setDeliveryCompany(java.lang.String _deliveryCompany)
void	setDeliveryCountry(java.lang.String _deliveryCountry)
void	setDeliveryCountryObject(S_Country _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(S_Zone _deliveryZoneObject)
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	setNumProducts(int _numProducts)
void	setOrderNumber(java.lang.String _orderNumber) The order number of the order
void	setOrderProducts(S_OrderProduct[] _orderProducts) An array of OrderProduct objects which define the products contained within the order.
void	setOrderTotals(S_OrderTotal[] _orderTotals) An array of OrderTotal objects that contain information such as the sub total, the shipping, the discount and the total.
void	setPaymentDetails(S_PaymentDetails _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	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(S_ShippingQuote _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(S_OrderStatusHistory[] _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(S_TaxRate[] _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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

S_Order

public S_Order()

Method Detail

getBillingCity

public java.lang.String getBillingCity()

Returns:

Returns the billingCity.

setBillingCity

public void setBillingCity(java.lang.String _billingCity)

Parameters:

_billingCity - The billingCity to set.

getBillingCompany

public java.lang.String getBillingCompany()

Returns:

Returns the billingCompany.

setBillingCompany

public void setBillingCompany(java.lang.String _billingCompany)

Parameters:

_billingCompany - The billingCompany to set.

getBillingCountry

public java.lang.String getBillingCountry()

Returns:

Returns the billingCountry.

setBillingCountry

public void setBillingCountry(java.lang.String _billingCountry)

Parameters:

_billingCountry - The billingCountry to set.

getBillingName

public java.lang.String getBillingName()

Returns:

Returns the billingName.

setBillingName

public void setBillingName(java.lang.String _billingName)

Parameters:

_billingName - The billingName to set.

getBillingPostcode

public java.lang.String getBillingPostcode()

Returns:

Returns the billingPostcode.

setBillingPostcode

public void setBillingPostcode(java.lang.String _billingPostcode)

Parameters:

_billingPostcode - The billingPostcode to set.

getBillingState

public java.lang.String getBillingState()

Returns:

Returns the billingState.

setBillingState

public void setBillingState(java.lang.String _billingState)

Parameters:

_billingState - The billingState to set.

getBillingStreetAddress

public java.lang.String getBillingStreetAddress()

Returns:

Returns the billingStreetAddress.

setBillingStreetAddress

public void setBillingStreetAddress(java.lang.String _billingStreetAddress)

Parameters:

_billingStreetAddress - The billingStreetAddress to set.

getBillingStreetAddress1

public java.lang.String getBillingStreetAddress1()

Returns:

the billingStreetAddress1

setBillingStreetAddress1

public void setBillingStreetAddress1(java.lang.String _billingStreetAddress1)

Parameters:

_billingStreetAddress1 - the billingStreetAddress1 to set

getBillingSuburb

public java.lang.String getBillingSuburb()

Returns:

Returns the billingSuburb.

setBillingSuburb

public void setBillingSuburb(java.lang.String _billingSuburb)

Parameters:

_billingSuburb - The billingSuburb to set.

getCcExpires

public java.lang.String getCcExpires()

Returns:

Returns the ccExpires.

setCcExpires

public void setCcExpires(java.lang.String _ccExpires)

Parameters:

_ccExpires - The ccExpires to set.

getCcNumber

public java.lang.String getCcNumber()

Returns:

Returns the ccNumber.

setCcNumber

public void setCcNumber(java.lang.String _ccNumber)

Parameters:

_ccNumber - The ccNumber to set.

getCcOwner

public java.lang.String getCcOwner()

Returns:

Returns the ccOwner.

setCcOwner

public void setCcOwner(java.lang.String _ccOwner)

Parameters:

_ccOwner - The ccOwner to set.

getCcType

public java.lang.String getCcType()

Returns:

Returns the ccType.

setCcType

public void setCcType(java.lang.String _ccType)

Parameters:

_ccType - The ccType to set.

getCurrencyValue

public java.math.BigDecimal getCurrencyValue()

The exchange rate for the currency.

Returns:

Returns the currencyValue.

setCurrencyValue

public void setCurrencyValue(java.math.BigDecimal _currencyValue)

The exchange rate for the currency.

Parameters:

_currencyValue - The currencyValue to set.

getCustomerCity

public java.lang.String getCustomerCity()

Returns:

Returns the customerCity.

setCustomerCity

public void setCustomerCity(java.lang.String _customerCity)

Parameters:

_customerCity - The customerCity to set.

getCustomerCompany

public java.lang.String getCustomerCompany()

Returns:

Returns the customerCompany.

setCustomerCompany

public void setCustomerCompany(java.lang.String _customerCompany)

Parameters:

_customerCompany - The customerCompany to set.

getCustomerCountry

public java.lang.String getCustomerCountry()

Returns:

Returns the customerCountry.

setCustomerCountry

public void setCustomerCountry(java.lang.String _customerCountry)

Parameters:

_customerCountry - The customerCountry to set.

getCustomerEmail

public java.lang.String getCustomerEmail()

Returns:

Returns the customerEmail.

setCustomerEmail

public void setCustomerEmail(java.lang.String _customerEmail)

Parameters:

_customerEmail - The customerEmail to set.

getCustomerName

public java.lang.String getCustomerName()

Returns:

Returns the customerName.

setCustomerName

public void setCustomerName(java.lang.String _customerName)

Parameters:

_customerName - The customerName to set.

getCustomerPostcode

public java.lang.String getCustomerPostcode()

Returns:

Returns the customerPostcode.

setCustomerPostcode

public void setCustomerPostcode(java.lang.String _customerPostcode)

Parameters:

_customerPostcode - The customerPostcode to set.

getCustomerState

public java.lang.String getCustomerState()

Returns:

Returns the customerState.

setCustomerState

public void setCustomerState(java.lang.String _customerState)

Parameters:

_customerState - The customerState to set.

getCustomerStreetAddress

public java.lang.String getCustomerStreetAddress()

Returns:

Returns the customerStreetAddress.

setCustomerStreetAddress

public void setCustomerStreetAddress(java.lang.String _customerStreetAddress)

Parameters:

_customerStreetAddress - The customerStreetAddress to set.

getCustomerStreetAddress1

public java.lang.String getCustomerStreetAddress1()

Returns:

the customerStreetAddress1

setCustomerStreetAddress1

public void setCustomerStreetAddress1(java.lang.String _customerStreetAddress1)

Parameters:

_customerStreetAddress1 - the customerStreetAddress1 to set

getCustomerSuburb

public java.lang.String getCustomerSuburb()

Returns:

Returns the customerSuburb.

setCustomerSuburb

public void setCustomerSuburb(java.lang.String _customerSuburb)

Parameters:

_customerSuburb - The customerSuburb to set.

getCustomerTelephone

public java.lang.String getCustomerTelephone()

Returns:

Returns the customerTelephone.

setCustomerTelephone

public void setCustomerTelephone(java.lang.String _customerTelephone)

Parameters:

_customerTelephone - The customerTelephone to set.

getDateFinished

public java.util.Calendar getDateFinished()

Returns:

Returns the dateFinished.

setDateFinished

public void setDateFinished(java.util.Calendar _dateFinished)

Parameters:

_dateFinished - The dateFinished to set.

getDatePurchased

public java.util.Calendar getDatePurchased()

The date that the order was saved.

Returns:

Returns the datePurchased.

setDatePurchased

public void setDatePurchased(java.util.Calendar _datePurchased)

The date that the order was saved.

Parameters:

_datePurchased - The datePurchased to set.

getDeliveryCity

public java.lang.String getDeliveryCity()

Returns:

Returns the deliveryCity.

setDeliveryCity

public void setDeliveryCity(java.lang.String _deliveryCity)

Parameters:

_deliveryCity - The deliveryCity to set.

getDeliveryCompany

public java.lang.String getDeliveryCompany()

Returns:

Returns the deliveryCompany.

setDeliveryCompany

public void setDeliveryCompany(java.lang.String _deliveryCompany)

Parameters:

_deliveryCompany - The deliveryCompany to set.

getDeliveryCountry

public java.lang.String getDeliveryCountry()

Returns:

Returns the deliveryCountry.

setDeliveryCountry

public void setDeliveryCountry(java.lang.String _deliveryCountry)

Parameters:

_deliveryCountry - The deliveryCountry to set.

getDeliveryName

public java.lang.String getDeliveryName()

Returns:

Returns the deliveryName.

setDeliveryName

public void setDeliveryName(java.lang.String _deliveryName)

Parameters:

_deliveryName - The deliveryName to set.

getDeliveryPostcode

public java.lang.String getDeliveryPostcode()

Returns:

Returns the deliveryPostcode.

setDeliveryPostcode

public void setDeliveryPostcode(java.lang.String _deliveryPostcode)

Parameters:

_deliveryPostcode - The deliveryPostcode to set.

getDeliveryState

public java.lang.String getDeliveryState()

Returns:

Returns the deliveryState.

setDeliveryState

public void setDeliveryState(java.lang.String _deliveryState)

Parameters:

_deliveryState - The deliveryState to set.

getDeliveryStreetAddress

public java.lang.String getDeliveryStreetAddress()

Returns:

Returns the deliveryStreetAddress.

setDeliveryStreetAddress

public void setDeliveryStreetAddress(java.lang.String _deliveryStreetAddress)

Parameters:

_deliveryStreetAddress - The deliveryStreetAddress to set.

getDeliveryStreetAddress1

public java.lang.String getDeliveryStreetAddress1()

Returns:

the deliveryStreetAddress1

setDeliveryStreetAddress1

public void setDeliveryStreetAddress1(java.lang.String _deliveryStreetAddress1)

Parameters:

_deliveryStreetAddress1 - the deliveryStreetAddress1 to set

getDeliverySuburb

public java.lang.String getDeliverySuburb()

Returns:

Returns the deliverySuburb.

setDeliverySuburb

public void setDeliverySuburb(java.lang.String _deliverySuburb)

Parameters:

_deliverySuburb - The deliverySuburb to set.

getId

public int getId()

Returns:

Returns the id.

setId

public void setId(int _id)

Parameters:

_id - The id to set.

getLastModified

public java.util.Calendar getLastModified()

Returns:

Returns the lastModified.

setLastModified

public void setLastModified(java.util.Calendar _lastModified)

Parameters:

_lastModified - The lastModified to set.

getPaymentMethod

public java.lang.String getPaymentMethod()

Returns:

Returns the paymentMethod.

setPaymentMethod

public void setPaymentMethod(java.lang.String _paymentMethod)

Parameters:

_paymentMethod - The paymentMethod to set.

getShippingMethod

public 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

public void setShippingMethod(java.lang.String _shippingMethod)

Parameters:

_shippingMethod - The shippingMethod to set.

getStatus

public int getStatus()

The current integer status id. The orders_status table contains a description of this status id.

Returns:

Returns the status.

setStatus

public 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

public int getCustomerId()

Returns:

Returns the customerId.

setCustomerId

public void setCustomerId(int _customerId)

Parameters:

_customerId - The customerId to set.

getBillingAddrFormatId

public int getBillingAddrFormatId()

The id of the address format template used to format the billing address.

Returns:

Returns the billingAddrFormatId.

setBillingAddrFormatId

public void setBillingAddrFormatId(int _billingAddrFormatId)

The id of the address format template used to format the billing address.

Parameters:

_billingAddrFormatId - The billingAddrFormatId to set.

getCustomerAddrFormatId

public int getCustomerAddrFormatId()

The id of the address format template used to format the customer address.

Returns:

Returns the customerAddrFormatId.

setCustomerAddrFormatId

public void setCustomerAddrFormatId(int _customerAddrFormatId)

The id of the address format template used to format the customer address.

Parameters:

_customerAddrFormatId - The customerAddrFormatId to set.

getDeliveryAddrFormatId

public int getDeliveryAddrFormatId()

The id of the address format template used to format the delivery address.

Returns:

Returns the deliveryAddrFormatId.

setDeliveryAddrFormatId

public void setDeliveryAddrFormatId(int _deliveryAddrFormatId)

The id of the address format template used to format the delivery address.

Parameters:

_deliveryAddrFormatId - The deliveryAddrFormatId to set.

getOrderProducts

public S_OrderProduct[] getOrderProducts()

An array of OrderProduct objects which define the products contained within the order.

Returns:

Returns the orderProducts.

setOrderProducts

public void setOrderProducts(S_OrderProduct[] _orderProducts)

An array of OrderProduct objects which define the products contained within the order.

Parameters:

_orderProducts - The orderProducts to set.

getBillingFormattedAddress

public java.lang.String getBillingFormattedAddress()

The formatted billing address which has been formatted using the address format template.

Returns:

Returns the billingFormattedAddress.

setBillingFormattedAddress

public 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

public java.lang.String getCustomerFormattedAddress()

The formatted customer address which has been formatted using the address format template.

Returns:

Returns the customerFormattedAddress.

setCustomerFormattedAddress

public 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

public java.lang.String getDeliveryFormattedAddress()

The formatted delivery address which has been formatted using the address format template.

Returns:

Returns the deliveryFormattedAddress.

setDeliveryFormattedAddress

public 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

public java.lang.String getStatusText()

Text explaining the status.

Returns:

Returns the statusText.

setStatusText

public void setStatusText(java.lang.String _statusText)

Text explaining the status.

Parameters:

_statusText - The statusText to set.

getTax

public java.math.BigDecimal getTax()

Returns:

Returns the tax.

setTax

public void setTax(java.math.BigDecimal _tax)

Parameters:

_tax - The tax to set.

getNumProducts

public int getNumProducts()

Returns:

Returns the numProducts.

setNumProducts

public void setNumProducts(int _numProducts)

Parameters:

_numProducts - The numProducts to set.

getBillingAddrFormatTemplate

public java.lang.String getBillingAddrFormatTemplate()

The address format template for the billing address.

Returns:

Returns the billingAddrFormatTemplate.

setBillingAddrFormatTemplate

public void setBillingAddrFormatTemplate(java.lang.String _billingAddrFormatTemplate)

The address format template for the billing address.

Parameters:

_billingAddrFormatTemplate - The billingAddrFormatTemplate to set.

getCustomerAddrFormatTemplate

public java.lang.String getCustomerAddrFormatTemplate()

The address format template for the customer address.

Returns:

Returns the customerAddrFormatTemplate.

setCustomerAddrFormatTemplate

public void setCustomerAddrFormatTemplate(java.lang.String _customerAddrFormatTemplate)

The address format template for the customer address.

Parameters:

_customerAddrFormatTemplate - The customerAddrFormatTemplate to set.

getDeliveryAddrFormatTemplate

public java.lang.String getDeliveryAddrFormatTemplate()

The address format template for the delivery address.

Returns:

Returns the deliveryAddrFormatTemplate.

setDeliveryAddrFormatTemplate

public void setDeliveryAddrFormatTemplate(java.lang.String _deliveryAddrFormatTemplate)

The address format template for the delivery address.

Parameters:

_deliveryAddrFormatTemplate - The deliveryAddrFormatTemplate to set.

getOrderTotals

public S_OrderTotal[] 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

public void setOrderTotals(S_OrderTotal[] _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

public S_OrderStatusHistory[] 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

public void setStatusTrail(S_OrderStatusHistory[] _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

public int getBillingAddrId()

Returns:

Returns the billingAddrId.

setBillingAddrId

public void setBillingAddrId(int _billingAddrId)

Parameters:

_billingAddrId - The billingAddrId to set.

getCustomerAddrId

public int getCustomerAddrId()

Returns:

Returns the customerAddrId.

setCustomerAddrId

public void setCustomerAddrId(int _customerAddrId)

Parameters:

_customerAddrId - The customerAddrId to set.

getDeliveryAddrId

public int getDeliveryAddrId()

Returns:

Returns the deliveryAddrId.

setDeliveryAddrId

public void setDeliveryAddrId(int _deliveryAddrId)

Parameters:

_deliveryAddrId - The deliveryAddrId to set.

getDeliveryCountryObject

public S_Country getDeliveryCountryObject()

Returns:

Returns the deliveryCountryObject.

setDeliveryCountryObject

public void setDeliveryCountryObject(S_Country _deliveryCountryObject)

Parameters:

_deliveryCountryObject - The deliveryCountryObject to set.

getDeliveryZoneObject

public S_Zone getDeliveryZoneObject()

Returns:

Returns the deliveryZoneObject.

setDeliveryZoneObject

public void setDeliveryZoneObject(S_Zone _deliveryZoneObject)

Parameters:

_deliveryZoneObject - The deliveryZoneObject to set.

getTotalExTax

public java.math.BigDecimal getTotalExTax()

Returns:

Returns the totalExTax.

setTotalExTax

public void setTotalExTax(java.math.BigDecimal _totalExTax)

Parameters:

_totalExTax - The totalExTax to set.

getTotalIncTax

public java.math.BigDecimal getTotalIncTax()

Returns:

Returns the totalIncTax.

setTotalIncTax

public void setTotalIncTax(java.math.BigDecimal _totalIncTax)

Parameters:

_totalIncTax - The totalIncTax to set.

getShippingQuote

public S_ShippingQuote getShippingQuote()

Returns:

Returns the shippingQuote.

setShippingQuote

public void setShippingQuote(S_ShippingQuote _shippingQuote)

Parameters:

_shippingQuote - The shippingQuote to set.

getCurrencyCode

public java.lang.String getCurrencyCode()

The three letter currency code. e.g. USD

Returns:

Returns the currencyCode.

setCurrencyCode

public void setCurrencyCode(java.lang.String _currencyCode)

The three letter currency code. e.g. USD

Parameters:

_currencyCode - The currencyCode to set.

getCurrency

public S_Currency getCurrency()

Returns:

Returns the currency.

setCurrency

public void setCurrency(S_Currency _currency)

Parameters:

_currency - The currency to set.

getTaxRateObjectArray

public S_TaxRate[] getTaxRateObjectArray()

The order may be subject to multiple tax rates which are compounded.

Returns:

Returns the taxRateObjectArray.

setTaxRateObjectArray

public void setTaxRateObjectArray(S_TaxRate[] _taxRateObjectArray)

The order may be subject to multiple tax rates which are compounded.

Parameters:

_taxRateObjectArray - The taxRateObjectArray to set.

getPaymentDetails

public S_PaymentDetails getPaymentDetails()

Returns:

Returns the paymentDetails.

setPaymentDetails

public void setPaymentDetails(S_PaymentDetails _paymentDetails)

Parameters:

_paymentDetails - The paymentDetails to set.

getCustom1

public java.lang.String getCustom1()

Returns:

Returns the custom1.

setCustom1

public void setCustom1(java.lang.String _custom1)

Parameters:

_custom1 - The custom1 to set.

getCustom2

public java.lang.String getCustom2()

Returns:

Returns the custom2.

setCustom2

public void setCustom2(java.lang.String _custom2)

Parameters:

_custom2 - The custom2 to set.

getCustom3

public java.lang.String getCustom3()

Returns:

Returns the custom3.

setCustom3

public void setCustom3(java.lang.String _custom3)

Parameters:

_custom3 - The custom3 to set.

getCustom4

public java.lang.String getCustom4()

Returns:

Returns the custom4.

setCustom4

public void setCustom4(java.lang.String _custom4)

Parameters:

_custom4 - The custom4 to set.

getCustom5

public java.lang.String getCustom5()

Returns:

Returns the custom5.

setCustom5

public void setCustom5(java.lang.String _custom5)

Parameters:

_custom5 - The custom5 to set.

getCouponCode

public java.lang.String getCouponCode()

The coupon code used when checking out.

Returns:

Returns the couponCode.

setCouponCode

public void setCouponCode(java.lang.String _couponCode)

The coupon code used when checking out.

Parameters:

_couponCode - The couponCode to set.

getSubTotalExTax

public java.math.BigDecimal getSubTotalExTax()

Returns:

Returns the subTotalExTax.

setSubTotalExTax

public void setSubTotalExTax(java.math.BigDecimal _subTotalExTax)

Parameters:

_subTotalExTax - The subTotalExTax to set.

getSubTotalIncTax

public java.math.BigDecimal getSubTotalIncTax()

Returns:

Returns the subTotalIncTax.

setSubTotalIncTax

public void setSubTotalIncTax(java.math.BigDecimal _subTotalIncTax)

Parameters:

_subTotalIncTax - The subTotalIncTax to set.

getCouponIds

public java.lang.String getCouponIds()

A comma separated list of coupon ids.

Returns:

Returns the couponIds.

setCouponIds

public void setCouponIds(java.lang.String _couponIds)

A comma separated list of coupon ids.

Parameters:

_couponIds - The couponIds to set.

getPromotionIds

public java.lang.String getPromotionIds()

A comma separated list of promotion ids.

Returns:

Returns the promotionIds.

setPromotionIds

public void setPromotionIds(java.lang.String _promotionIds)

A comma separated list of promotion ids.

Parameters:

_promotionIds - The promotionIds to set.

getPaymentModuleCode

public java.lang.String getPaymentModuleCode()

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

Returns:

Returns the paymentModuleCode.

setPaymentModuleCode

public 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

public java.lang.String getShippingModuleCode()

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

Returns:

Returns the shippingModuleCode.

setShippingModuleCode

public void setShippingModuleCode(java.lang.String _shippingModuleCode)

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

Parameters:

_shippingModuleCode - The shippingModuleCode to set.

getOrderNumber

public java.lang.String getOrderNumber()

The order number of the order

Returns:

Returns the orderNumber.

setOrderNumber

public void setOrderNumber(java.lang.String _orderNumber)

The order number of the order

Parameters:

_orderNumber - The orderNumber to set.

getLifecycleId

public java.lang.String getLifecycleId()

Instantiated when the order is created. Can be used to identify the order even before it is saved, which is when the id and order number are created.

Returns:

the lifecycleId

setLifecycleId

public void setLifecycleId(java.lang.String _lifecycleId)

Instantiated when the order is created. Can be used to identify the order even before it is saved, which is when the id and order number are created.

Parameters:

_lifecycleId - the lifecycleId to set

getTrackingNumber

public java.lang.String getTrackingNumber()

The tracking number of the order.

Returns:

the trackingNumber

setTrackingNumber

public void setTrackingNumber(java.lang.String _trackingNumber)

The tracking number of the order.

Parameters:

_trackingNumber - the trackingNumber to set

getPointsRedeemed

public int getPointsRedeemed()

The number of Reward Points redeemed for the order

Returns:

the pointsRedeemed

setPointsRedeemed

public void setPointsRedeemed(int _pointsRedeemed)

The number of Reward Points redeemed for the order

Parameters:

_pointsRedeemed - the pointsRedeemed to set

getPointsAwarded

public int getPointsAwarded()

The number of Reward Points rewarded for the order

Returns:

the pointsAwarded

setPointsAwarded

public void setPointsAwarded(int _pointsAwarded)

The number of Reward Points rewarded for the order

Parameters:

_pointsAwarded - the pointsAwarded to set

getPointsReservationId

public int getPointsReservationId()

The numeric id of the points reserved for this order. If the order isn't confirmed and eventually canceled, the id can be used to return the points back to the customer.

Returns:

the pointsReservationId

setPointsReservationId

public void setPointsReservationId(int _pointsReservationId)

The numeric id of the points reserved for this order. If the order isn't confirmed and eventually canceled, the id can be used to return the points back to the customer.

Parameters:

_pointsReservationId - the pointsReservationId to set

getLocale

public java.lang.String getLocale()

Locale of the customer

Returns:

the locale

setLocale

public void setLocale(java.lang.String _locale)

Locale of the customer

Parameters:

_locale - the locale to set

getGiftCertCode

public java.lang.String getGiftCertCode()

The code of the gift certificate

Returns:

the giftCertCode

setGiftCertCode

public void setGiftCertCode(java.lang.String _giftCertCode)

The code of the gift certificate

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)

Returns:

the invoice filename

setInvoiceFilename

public void setInvoiceFilename(java.lang.String _invoiceFilename)

The filename of the invoice

Parameters:

_invoiceFilename - the filename to set

getCcCVV

public java.lang.String getCcCVV()

Credit card ccCVV

Returns:

the ccCVV

setCcCVV

public void setCcCVV(java.lang.String _ccCVV)

Credit card ccCVV

Parameters:

_ccCVV - the ccCVV to set

getCustomerTelephone1

public java.lang.String getCustomerTelephone1()

Returns:

the customerTelephone1

setCustomerTelephone1

public void setCustomerTelephone1(java.lang.String _customerTelephone1)

Parameters:

_customerTelephone1 - the customerTelephone1 to set

getDeliveryTelephone

public java.lang.String getDeliveryTelephone()

Returns:

the deliveryTelephone

setDeliveryTelephone

public void setDeliveryTelephone(java.lang.String _deliveryTelephone)

Parameters:

_deliveryTelephone - the deliveryTelephone to set

getDeliveryTelephone1

public java.lang.String getDeliveryTelephone1()

Returns:

the deliveryTelephone1

setDeliveryTelephone1

public void setDeliveryTelephone1(java.lang.String _deliveryTelephone1)

Parameters:

_deliveryTelephone1 - the deliveryTelephone1 to set

getDeliveryEmail

public java.lang.String getDeliveryEmail()

Returns:

the deliveryEmail

setDeliveryEmail

public void setDeliveryEmail(java.lang.String _deliveryEmail)

Parameters:

_deliveryEmail - the deliveryEmail to set

getBillingTelephone

public java.lang.String getBillingTelephone()

Returns:

the billingTelephone

setBillingTelephone

public void setBillingTelephone(java.lang.String _billingTelephone)

Parameters:

_billingTelephone - the billingTelephone to set

getBillingTelephone1

public java.lang.String getBillingTelephone1()

Returns:

the billingTelephone1

setBillingTelephone1

public void setBillingTelephone1(java.lang.String _billingTelephone1)

Parameters:

_billingTelephone1 - the billingTelephone1 to set

getBillingEmail

public java.lang.String getBillingEmail()

Returns:

the billingEmail

setBillingEmail

public void setBillingEmail(java.lang.String _billingEmail)

Parameters:

_billingEmail - the billingEmail to set

getShippingServiceCode

public java.lang.String getShippingServiceCode()

Used for shipping modules such as UPS, FedEx etc. to keep track of which service code was selected by the customer.

Returns:

the shippingServiceCode

setShippingServiceCode

public void setShippingServiceCode(java.lang.String _shippingServiceCode)

Used for shipping modules such as UPS, FedEx etc. to keep track of which service code was selected by the customer.

Parameters:

_shippingServiceCode - the shippingServiceCode to set

getCreator

public java.lang.String getCreator()

Identifier of the administrator who created the order

Returns:

the creator

setCreator

public void setCreator(java.lang.String _creator)

Identifier of the administrator who created the order

Parameters:

_creator - the creator to set

getAffiliateId

public java.lang.String getAffiliateId()

Id of affiliate partner

Returns:

the affiliateId

setAffiliateId

public void setAffiliateId(java.lang.String _affiliateId)

Id of affiliate partner

Parameters:

_affiliateId - the affiliateId to set