com.ibm.commerce.me.datatype
Class PurchaseOrderHeader

java.lang.Object
  |
  +--com.ibm.commerce.me.datatype.PurchaseOrderHeader
All Implemented Interfaces:
java.io.Serializable

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

This class encapsulates information for a purchase order. Information stored such as order date, order ID, order type, payload id for the order, total order, currency used, shipping address, billing address, url to which order status is to be posted, shipping information, pay method, tax information, comment, and ship mode.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright field
 
Constructor Summary
PurchaseOrderHeader()
           
 
Method Summary
  Address getBillTo()
          Gets the billto address
 java.lang.String getComment()
          Gets the comment
 java.lang.String getCurrency()
          Gets the currency
 java.lang.String getMessageId()
          Gets the messageId of the order
 java.util.Date getOrderDate()
          Gets the order date.
 java.lang.String getOrderId()
          Gets the order identification number
 java.lang.String getOrderStatusUrl()
          Gets the order status URL
 java.lang.String getOrderType()
          Gets the type of the order
  PaymentInfo getPayMethod()
          Gets the payment method
 java.lang.String getShipModeId()
          Gets the shipping mode ID
  ShippingInfo getShippingInfo()
          Gets the shipping info.
  Address getShipTo()
          Gets the shipto address
  TaxInfo getTaxInfo()
          Gets the tax info
 java.math.BigDecimal getTotalAmount()
          Gets the total amount
 void setBillTo( Address newBillTo)
          Sets the billto address
 void setComment(java.lang.String newComment)
          Sets the comment
 void setCurrency(java.lang.String newCurrency)
          Sets the currency
 void setMessageId(java.lang.String messageId)
          Sets the messageId of the order
 void setOrderDate(java.util.Date newOrderDate)
          Sets the order date.
 void setOrderId(java.lang.String newOrderId)
          Sets the order identification number
 void setOrderStatusUrl(java.lang.String newOrderStatusUrl)
          Sets the order status URL
 void setOrderType(java.lang.String newOrderType)
          Sets the type of the order
 void setPayMethod( PaymentInfo newPayMethod)
          Sets the payment method
 void setShipModeId(java.lang.String shipmodeId)
          Sets the ship mode id
 void setShippingInfo( ShippingInfo newShippingInfo)
          Sets the shipping info.
 void setShipTo( Address newShipTo)
          Sets the shipto address
 void setTaxInfo( TaxInfo newTaxInfo)
          Sets the tax info
 void setTotalAmount(java.math.BigDecimal newTotalAmount)
          Sets the total amount
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright field
See Also:
Constant Field Values
Constructor Detail

PurchaseOrderHeader

public PurchaseOrderHeader()
Method Detail

getBillTo

public Address getBillTo()
Gets the billto address
Returns:
the billing address

getComment

public java.lang.String getComment()
Gets the comment
Returns:
the comment for this order

getCurrency

public java.lang.String getCurrency()
Gets the currency
Returns:
the currency used to measure the total amount

getMessageId

public java.lang.String getMessageId()
Gets the messageId of the order
Returns:
the mapped payloadID in the XML message

getOrderDate

public java.util.Date getOrderDate()
Gets the order date.
Returns:
the date this order is created

getOrderId

public java.lang.String getOrderId()
Gets the order identification number
Returns:
the order id identifying this order

getOrderStatusUrl

public java.lang.String getOrderStatusUrl()
Gets the order status URL
Returns:
the URL for the status to be posted

getOrderType

public java.lang.String getOrderType()
Gets the type of the order
Returns:
the order type

getPayMethod

public PaymentInfo getPayMethod()
Gets the payment method
Returns:
the payment information

getShipModeId

public java.lang.String getShipModeId()
Gets the shipping mode ID
Returns:
the code identifying the shipping mode

getShippingInfo

public ShippingInfo getShippingInfo()
Gets the shipping info.
Returns:
the shipping information

getShipTo

public Address getShipTo()
Gets the shipto address
Returns:
the shipping address

getTaxInfo

public TaxInfo getTaxInfo()
Gets the tax info
Returns:
the tax information

getTotalAmount

public java.math.BigDecimal getTotalAmount()
Gets the total amount
Returns:
the total amount

setBillTo

public void setBillTo(Address newBillTo)
Sets the billto address

setComment

public void setComment(java.lang.String newComment)
Sets the comment
Parameters:
newComment - the order comment

setCurrency

public void setCurrency(java.lang.String newCurrency)
Sets the currency
Parameters:
newCurrency - the new currency used to calcualte the order

setMessageId

public void setMessageId(java.lang.String messageId)
Sets the messageId of the order
Parameters:
messageId - this field is mapped to payloadID in the actual xml message

setOrderDate

public void setOrderDate(java.util.Date newOrderDate)
Sets the order date.
Parameters:
newOrderDate - date when this order is created

setOrderId

public void setOrderId(java.lang.String newOrderId)
Sets the order identification number
Parameters:
newOrderId - the id identifying the current order

setOrderStatusUrl

public void setOrderStatusUrl(java.lang.String newOrderStatusUrl)
Sets the order status URL
Parameters:
newOrderStatusUrl - the URL to which the order status should be posted

setOrderType

public void setOrderType(java.lang.String newOrderType)
Sets the type of the order
Parameters:
newOrderType - the code identifying the order type

setPayMethod

public void setPayMethod(PaymentInfo newPayMethod)
Sets the payment method
Parameters:
newPayMethod - the payment method information

setShipModeId

public void setShipModeId(java.lang.String shipmodeId)
Sets the ship mode id
Parameters:
shipmodeId - the code identifying the shipping mode

setShippingInfo

public void setShippingInfo(ShippingInfo newShippingInfo)
Sets the shipping info.
Parameters:
newShippingInfo - the shipping information

setShipTo

public void setShipTo(Address newShipTo)
Sets the shipto address
Parameters:
newShipTo - the new shipping address

setTaxInfo

public void setTaxInfo(TaxInfo newTaxInfo)
Sets the tax info
Parameters:
newTaxInfo - the tax information

setTotalAmount

public void setTotalAmount(java.math.BigDecimal newTotalAmount)
Sets the total amount
Parameters:
newTotalAmount - the total amount