com.konakartadmin.app
Class AdminOrder

java.lang.Object
  com.konakartadmin.app.AdminOrder

All Implemented Interfaces:

AdminObjectIf

public class AdminOrder
extends java.lang.Object
implements AdminObjectIf

Order object for the Admin App

Field Summary

private int	billingAddrFormatId billingAddrFormatId
private java.lang.String	billingAddrFormatTemplate billingAddrFormatTemplate
private int	billingAddrId billingAddrId
private java.lang.String	billingCity billingCity
private java.lang.String	billingCompany billingCompany
private java.lang.String	billingCountry billingCountry
private java.lang.String	billingFormattedAddress billingFormattedAddress
private java.lang.String	billingName billingName
private java.lang.String	billingPostcode billingPostcode
private java.lang.String	billingState billingState
private java.lang.String	billingStreetAddress billingStreetAddress
private java.lang.String	billingSuburb billingSuburb
private java.lang.String	ccExpires ccExpires
private java.lang.String	ccNumber ccNumber
private java.lang.String	ccOwner ccOwner
private java.lang.String	ccType ccType
private java.lang.String	couponIds
private AdminCurrency	currency currency
private java.lang.String	currencyCode currencyCode
private java.math.BigDecimal	currencyValue currencyValue
private java.lang.String	custom1 custom field
private java.lang.String	custom2 custom field
private java.lang.String	custom3 custom field
private java.lang.String	custom4 custom field
private java.lang.String	custom5 custom field
private int	customerAddrFormatId customerAddrFormatId
private java.lang.String	customerAddrFormatTemplate customerAddrFormatTemplate
private int	customerAddrId customerAddrId
private java.lang.String	customerCity customerCity
private java.lang.String	customerCompany customerCompany
private java.lang.String	customerCountry customerCountry
private java.lang.String	customerEmail customerEmail
private java.lang.String	customerFormattedAddress customerFormattedAddress
private int	customerId customerId
private java.lang.String	customerName customerName
private java.lang.String	customerPostcode customerPostcode
private java.lang.String	customerState customerState
private java.lang.String	customerStreetAddress customerStreetAddress
private java.lang.String	customerSuburb customerSuburb
private java.lang.String	customerTelephone customerTelephone
private java.util.Date	dateFinished dateFinished
private java.util.Date	datePurchased datePurchased
private int	deliveryAddrFormatId deliveryAddrFormatId
private java.lang.String	deliveryAddrFormatTemplate deliveryAddrFormatTemplate
private int	deliveryAddrId deliveryAddrId
private java.lang.String	deliveryCity deliveryCity
private java.lang.String	deliveryCompany deliveryCompany
private java.lang.String	deliveryCountry deliveryCountry
private AdminCountry	deliveryCountryObject delivery country object
private java.lang.String	deliveryFormattedAddress deliveryFormattedAddress
private java.lang.String	deliveryName deliveryName
private java.lang.String	deliveryPostcode deliveryPostcode
private java.lang.String	deliveryState deliveryState
private java.lang.String	deliveryStreetAddress deliveryStreetAddress
private java.lang.String	deliverySuburb deliverySuburb
private AdminZone	deliveryZoneObject delivery zone object
private java.lang.String	formattedTotalIncTax total value of order including tax - formatted
private int	id id
private java.util.Date	lastModified lastModified
private int	numProducts total number of products
private AdminOrderProduct[]	orderProducts orderProducts
private AdminOrderReturn[]	orderReturns orderReturns
private AdminOrderTotal[]	orderTotals objects with text for order total
private AdminPaymentDetails	paymentDetails The chosen payment method
private java.lang.String	paymentMethod paymentMethod
private java.lang.String	paymentModuleCode The code of the shipping module used for the order (i.e.
private java.lang.String	promotionIds Promotion related data
private java.lang.String	shippingMethod shippingMethod
private java.lang.String	shippingModuleCode The code of the payment module used for the order (i.e.
private AdminShippingQuote	shippingQuote The chosen shipping method
private int	status status
private java.lang.String	statusText status text
private AdminOrderStatusHistory[]	statusTrail objects with order status history
private java.math.BigDecimal	tax total tax for order
private AdminTaxRate[]	taxRateObjectArray An array of all of the tax rates used by this order
private java.math.BigDecimal	totalExTax total value of order excluding tax
private java.math.BigDecimal	totalIncTax total value of order including tax

Constructor Summary

AdminOrder()
Constructor

AdminOrder(com.workingdogs.village.Record vr, org.apache.torque.util.Criteria c)
Instantiates the attributes of the Order object from a Record object

Method Summary

void	calculateShippingMethod() The shipping method is retrieved from one of the OrderTotal records and the shippingMethod attribute is set.
void	createFormattedAddresses() Based on the address templates, the formatted addresses are created.
int	getBillingAddrFormatId()
java.lang.String	getBillingAddrFormatTemplate()
int	getBillingAddrId()
java.lang.String	getBillingCity()
java.lang.String	getBillingCompany()
java.lang.String	getBillingCountry()
java.lang.String	getBillingFormattedAddress()
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	getCouponIds()
AdminCurrency	getCurrency()
java.lang.String	getCurrencyCode()
java.math.BigDecimal	getCurrencyValue()
java.lang.String	getCustom1()
java.lang.String	getCustom2()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
java.lang.String	getCustom5()
int	getCustomerAddrFormatId()
java.lang.String	getCustomerAddrFormatTemplate()
int	getCustomerAddrId()
java.lang.String	getCustomerCity()
java.lang.String	getCustomerCompany()
java.lang.String	getCustomerCountry()
java.lang.String	getCustomerEmail()
java.lang.String	getCustomerFormattedAddress()
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.Date	getDateFinished()
java.util.Date	getDatePurchased()
int	getDeliveryAddrFormatId()
java.lang.String	getDeliveryAddrFormatTemplate()
int	getDeliveryAddrId()
java.lang.String	getDeliveryCity()
java.lang.String	getDeliveryCompany()
java.lang.String	getDeliveryCountry()
AdminCountry	getDeliveryCountryObject()
java.lang.String	getDeliveryFormattedAddress()
java.lang.String	getDeliveryName()
java.lang.String	getDeliveryPostcode()
java.lang.String	getDeliveryState()
java.lang.String	getDeliveryStreetAddress()
java.lang.String	getDeliverySuburb()
AdminZone	getDeliveryZoneObject()
java.lang.String	getFormattedTotalIncTax()
int	getId()
java.util.Date	getLastModified()
int	getNumProducts()
AdminOrderProduct[]	getOrderProducts()
AdminOrderReturn[]	getOrderReturns()
AdminOrderTotal[]	getOrderTotals()
AdminPaymentDetails	getPaymentDetails()
java.lang.String	getPaymentMethod()
java.lang.String	getPaymentModuleCode()
java.lang.String	getPromotionIds()
java.lang.String	getShippingMethod() The shipping method is retrieved from one of the OrderTotal records.
java.lang.String	getShippingModuleCode()
AdminShippingQuote	getShippingQuote()
int	getStatus()
java.lang.String	getStatusText()
AdminOrderStatusHistory[]	getStatusTrail()
java.math.BigDecimal	getTax()
AdminTaxRate[]	getTaxRateObjectArray()
java.math.BigDecimal	getTotalExTax()
java.math.BigDecimal	getTotalIncTax()
void	setAllAddresses(AdminAddress addr) Set all of the addresses of the order (customer, delivery and billing) to the address contained in the address object parameter.
void	setBillingAddress(AdminAddress addr) Set the billing address to the address contained in the address object parameter.
void	setBillingAddrFormatId(int billingAddrFormatId)
void	setBillingAddrFormatTemplate(java.lang.String billingAddrFormatTemplate)
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)
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	setCouponIds(java.lang.String couponIds)
void	setCurrency(AdminCurrency currency)
void	setCurrencyCode(java.lang.String currencyCode)
void	setCurrencyValue(java.math.BigDecimal currencyValue)
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	setCustomerAddress(AdminAddress addr) Set the customer address to the address contained in the address object parameter.
void	setCustomerAddrFormatId(int customerAddrFormatId)
void	setCustomerAddrFormatTemplate(java.lang.String customerAddrFormatTemplate)
void	setCustomerAddrId(int customerAddrId)
void	setCustomerCity(java.lang.String customerCity)
void	setCustomerCompany(java.lang.String customerCompany)
void	setCustomerCountry(java.lang.String customerCountry)
void	setCustomerDetails(AdminCustomer cust) Populatethe order with details from the customer.
void	setCustomerEmail(java.lang.String customerEmail)
void	setCustomerFormattedAddress(java.lang.String customerFormattedAddress)
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.Date dateFinished)
void	setDatePurchased(java.util.Date datePurchased)
void	setDeliveryAddress(AdminAddress addr) Set the delivery address to the address contained in the address object parameter.
void	setDeliveryAddrFormatId(int deliveryAddrFormatId)
void	setDeliveryAddrFormatTemplate(java.lang.String deliveryAddrFormatTemplate)
void	setDeliveryAddrId(int deliveryAddrId)
void	setDeliveryCity(java.lang.String deliveryCity)
void	setDeliveryCompany(java.lang.String deliveryCompany)
void	setDeliveryCountry(java.lang.String deliveryCountry)
void	setDeliveryCountryObject(AdminCountry deliveryCountryObject)
void	setDeliveryFormattedAddress(java.lang.String deliveryFormattedAddress)
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(AdminZone deliveryZoneObject)
void	setFormattedTotalIncTax(java.lang.String formattedTotalIncTax)
void	setId(int id)
void	setLastModified(java.util.Date lastModified)
void	setNumProducts(int numProducts)
void	setOrderProducts(AdminOrderProduct[] orderProducts)
void	setOrderReturns(AdminOrderReturn[] orderReturns)
void	setOrderTotals(AdminOrderTotal[] orderTotals)
void	setPaymentDetails(AdminPaymentDetails paymentDetails)
void	setPaymentMethod(java.lang.String paymentMethod)
void	setPaymentModuleCode(java.lang.String paymentModuleCode)
void	setPromotionIds(java.lang.String promotionIds)
void	setShippingMethod(java.lang.String shippingMethod)
void	setShippingModuleCode(java.lang.String shippingModuleCode)
void	setShippingQuote(AdminShippingQuote shippingQuote)
void	setStatus(int status)
void	setStatusText(java.lang.String statusText)
void	setStatusTrail(AdminOrderStatusHistory[] statusTrail)
void	setTax(java.math.BigDecimal tax)
void	setTaxRateObjectArray(AdminTaxRate[] taxRateObjectArray)
void	setTotalExTax(java.math.BigDecimal totalExTax)
void	setTotalIncTax(java.math.BigDecimal totalIncTax)
java.lang.String	toString()
java.lang.String	toStringBrief()

Methods inherited from class java.lang.Object

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

Field Detail

id

private int id

id

customerId

private int customerId

customerId

customerName

private java.lang.String customerName

customerName

customerCompany

private java.lang.String customerCompany

customerCompany

customerAddrId

private int customerAddrId

customerAddrId

customerStreetAddress

private java.lang.String customerStreetAddress

customerStreetAddress

customerSuburb

private java.lang.String customerSuburb

customerSuburb

customerCity

private java.lang.String customerCity

customerCity

customerPostcode

private java.lang.String customerPostcode

customerPostcode

customerState

private java.lang.String customerState

customerState

customerCountry

private java.lang.String customerCountry

customerCountry

customerTelephone

private java.lang.String customerTelephone

customerTelephone

customerEmail

private java.lang.String customerEmail

customerEmail

customerAddrFormatId

private int customerAddrFormatId

customerAddrFormatId

customerAddrFormatTemplate

private java.lang.String customerAddrFormatTemplate

customerAddrFormatTemplate

customerFormattedAddress

private java.lang.String customerFormattedAddress

customerFormattedAddress

shippingMethod

private java.lang.String shippingMethod

shippingMethod

deliveryName

private java.lang.String deliveryName

deliveryName

deliveryCompany

private java.lang.String deliveryCompany

deliveryCompany

deliveryAddrId

private int deliveryAddrId

deliveryAddrId

deliveryStreetAddress

private java.lang.String deliveryStreetAddress

deliveryStreetAddress

deliverySuburb

private java.lang.String deliverySuburb

deliverySuburb

deliveryCity

private java.lang.String deliveryCity

deliveryCity

deliveryPostcode

private java.lang.String deliveryPostcode

deliveryPostcode

deliveryState

private java.lang.String deliveryState

deliveryState

deliveryCountry

private java.lang.String deliveryCountry

deliveryCountry

deliveryAddrFormatId

private int deliveryAddrFormatId

deliveryAddrFormatId

deliveryAddrFormatTemplate

private java.lang.String deliveryAddrFormatTemplate

deliveryAddrFormatTemplate

deliveryFormattedAddress

private java.lang.String deliveryFormattedAddress

deliveryFormattedAddress

deliveryCountryObject

private AdminCountry deliveryCountryObject

delivery country object

deliveryZoneObject

private AdminZone deliveryZoneObject

delivery zone object

billingName

private java.lang.String billingName

billingName

billingCompany

private java.lang.String billingCompany

billingCompany

billingAddrId

private int billingAddrId

billingAddrId

billingStreetAddress

private java.lang.String billingStreetAddress

billingStreetAddress

billingSuburb

private java.lang.String billingSuburb

billingSuburb

billingCity

private java.lang.String billingCity

billingCity

billingPostcode

private java.lang.String billingPostcode

billingPostcode

billingState

private java.lang.String billingState

billingState

billingCountry

private java.lang.String billingCountry

billingCountry

billingAddrFormatId

private int billingAddrFormatId

billingAddrFormatId

billingAddrFormatTemplate

private java.lang.String billingAddrFormatTemplate

billingAddrFormatTemplate

billingFormattedAddress

private java.lang.String billingFormattedAddress

billingFormattedAddress

paymentMethod

private java.lang.String paymentMethod

paymentMethod

ccType

private java.lang.String ccType

ccType

ccOwner

private java.lang.String ccOwner

ccOwner

ccNumber

private java.lang.String ccNumber

ccNumber

ccExpires

private java.lang.String ccExpires

ccExpires

lastModified

private java.util.Date lastModified

lastModified

datePurchased

private java.util.Date datePurchased

datePurchased

status

private int status

status

statusText

private java.lang.String statusText

status text

dateFinished

private java.util.Date dateFinished

dateFinished

currencyCode

private java.lang.String currencyCode

currencyCode

currency

private AdminCurrency currency

currency

currencyValue

private java.math.BigDecimal currencyValue

currencyValue

orderProducts

private AdminOrderProduct[] orderProducts

orderProducts

orderReturns

private AdminOrderReturn[] orderReturns

orderReturns

totalExTax

private java.math.BigDecimal totalExTax

total value of order excluding tax

totalIncTax

private java.math.BigDecimal totalIncTax

total value of order including tax

formattedTotalIncTax

private java.lang.String formattedTotalIncTax

total value of order including tax - formatted

tax

private java.math.BigDecimal tax

total tax for order

taxRateObjectArray

private AdminTaxRate[] taxRateObjectArray

An array of all of the tax rates used by this order

numProducts

private int numProducts

total number of products

shippingQuote

private AdminShippingQuote shippingQuote

The chosen shipping method

paymentDetails

private AdminPaymentDetails paymentDetails

The chosen payment method

orderTotals

private AdminOrderTotal[] orderTotals

objects with text for order total

statusTrail

private AdminOrderStatusHistory[] statusTrail

objects with order status history

custom1

private java.lang.String custom1

custom field

custom2

private java.lang.String custom2

custom field

custom3

private java.lang.String custom3

custom field

custom4

private java.lang.String custom4

custom field

custom5

private java.lang.String custom5

custom field

promotionIds

private java.lang.String promotionIds

Promotion related data

couponIds

private java.lang.String couponIds

paymentModuleCode

private java.lang.String paymentModuleCode

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

shippingModuleCode

private java.lang.String shippingModuleCode

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

Constructor Detail

AdminOrder

public AdminOrder()

Constructor

AdminOrder

public AdminOrder(com.workingdogs.village.Record vr,
                  org.apache.torque.util.Criteria c)
           throws com.workingdogs.village.DataSetException

Instantiates the attributes of the Order object from a Record object

Parameters:

vr - Record containing data

c - Criteria containing column names

Throws:

com.workingdogs.village.DataSetException

Method Detail

toString

public java.lang.String toString()

Specified by:

toString in interface AdminObjectIf

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the Order object.

toStringBrief

public java.lang.String toStringBrief()

Returns:

Returns a string containing the attributes of the Order object.

setAllAddresses

public void setAllAddresses(AdminAddress addr)

Set all of the addresses of the order (customer, delivery and billing) to the address contained in the address object parameter.

Parameters:

addr -

calculateShippingMethod

public void calculateShippingMethod()

The shipping method is retrieved from one of the OrderTotal records and the shippingMethod attribute is set.

createFormattedAddresses

public void createFormattedAddresses()

Based on the address templates, the formatted addresses are created. The template can look something like this : '$firstname $lastname$cr$streets$cr$city, $postcode$cr$statecomma$country'

setCustomerAddress

public void setCustomerAddress(AdminAddress addr)

Set the customer address to the address contained in the address object parameter.

Parameters:

addr -

setDeliveryAddress

public void setDeliveryAddress(AdminAddress addr)

Set the delivery address to the address contained in the address object parameter.

Parameters:

addr -

setBillingAddress

public void setBillingAddress(AdminAddress addr)

Set the billing address to the address contained in the address object parameter.

Parameters:

addr -

setCustomerDetails

public void setCustomerDetails(AdminCustomer cust)

Populatethe order with details from the customer. The details are:

The details are:

• Telephone number
• Email address

Parameters:

cust -

getShippingMethod

public java.lang.String getShippingMethod()

The shipping method is retrieved from one of the OrderTotal records.

Returns:

Return the ShippingMethod

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.

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)</