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 includes:
- 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
- ship mode
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM Copyright field

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM Copyright field

Constructor Summary

Constructors
Constructor and Description

PurchaseOrderHeader()

Constructors
Constructor and Description
`PurchaseOrderHeader()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Address`	`getBillTo()` This method gets the billing address.
`java.lang.String`	`getComment()` This method gets the order comment.
`java.lang.String`	`getCurrency()` This method gets the order currency.
`java.lang.String`	`getMessageId()` This method gets the messageId of the order.
`java.util.Date`	`getOrderDate()` This method gets the order date.
`java.lang.String`	`getOrderId()` This method gets the order identification number.
`java.lang.String`	`getOrderStatusUrl()` This method gets the order status URL.
`java.lang.String`	`getOrderType()` This method gets the type of the order.
`PaymentInfo`	`getPayMethod()` This method gets the order payment method.
`java.lang.String`	`getShipModeId()` This method gets the shipping mode ID.
`ShippingInfo`	`getShippingInfo()` This method gets the order shipping info.
`Address`	`getShipTo()` This method gets the order shipping address.
`TaxInfo`	`getTaxInfo()` This method gets the order tax information.
`java.math.BigDecimal`	`getTotalAmount()` This method gets the total amount for the order.
`void`	`setBillTo(Address newBillTo)` This method sets the billing address.
`void`	`setComment(java.lang.String newComment)` This method sets the order comment.
`void`	`setCurrency(java.lang.String newCurrency)` This method sets the order currency.
`void`	`setMessageId(java.lang.String aMessageId)` This method sets the messageId of the order
`void`	`setOrderDate(java.util.Date newOrderDate)` This method sets the order date.
`void`	`setOrderId(java.lang.String newOrderId)` This method sets the order identification number.
`void`	`setOrderStatusUrl(java.lang.String newOrderStatusUrl)` This method sets the URL to post the order status.
`void`	`setOrderType(java.lang.String newOrderType)` This method sets the order type.
`void`	`setPayMethod(PaymentInfo newPayMethod)` This method sets the payment method.
`void`	`setShipModeId(java.lang.String shipmodeId)` This method sets the order ship mode ID.
`void`	`setShippingInfo(ShippingInfo newShippingInfo)` This method sets the order shipping information.
`void`	`setShipTo(Address newShipTo)` This method sets the order shiping address.
`void`	`setTaxInfo(TaxInfo newTaxInfo)` This method sets the order tax information.
`void`	`setTotalAmount(java.math.BigDecimal newTotalAmount)` This method sets the total order amount.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
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()
```
    This method gets the billing address.
    
    Returns:
    
    the billing address
  - getComment
```
public java.lang.String getComment()
```
    This method gets the order comment.
    
    Returns:
    
    the comment for this order
  - getCurrency
```
public java.lang.String getCurrency()
```
    This method gets the order currency.
    
    Returns:
    
    the currency used to measure the total amount
  - getMessageId
```
public java.lang.String getMessageId()
```
    This method gets the messageId of the order.
    
    Returns:
    
    the mapped payloadID in the XML message
  - getOrderDate
```
public java.util.Date getOrderDate()
```
    This method gets the order date.
    
    Returns:
    
    the date this order is created
  - getOrderId
```
public java.lang.String getOrderId()
```
    This method gets the order identification number.
    
    Returns:
    
    the order ID identifying this order
  - getOrderStatusUrl
```
public java.lang.String getOrderStatusUrl()
```
    This method gets the order status URL.
    
    Returns:
    
    the URL for the status to be posted
  - getOrderType
```
public java.lang.String getOrderType()
```
    This method gets the type of the order.
    
    Returns:
    
    the order type
  - getPayMethod
```
public PaymentInfo getPayMethod()
```
    This method gets the order payment method.
    
    Returns:
    
    the payment information
  - getShipModeId
```
public java.lang.String getShipModeId()
```
    This method gets the shipping mode ID.
    
    Returns:
    
    the code identifying the shipping mode
  - getShippingInfo
```
public ShippingInfo getShippingInfo()
```
    This method gets the order shipping info.
    
    Returns:
    
    the shipping information
  - getShipTo
```
public Address getShipTo()
```
    This method gets the order shipping address.
    
    Returns:
    
    the shipping address
  - getTaxInfo
```
public TaxInfo getTaxInfo()
```
    This method gets the order tax information.
    
    Returns:
    
    the tax information
  - getTotalAmount
```
public java.math.BigDecimal getTotalAmount()
```
    This method gets the total amount for the order.
    
    Returns:
    
    the total amount
  - setBillTo
```
public void setBillTo(Address newBillTo)
```
    This method sets the billing address.
    
    Parameters:
    
    newBillTo - the billing address
  - setComment
```
public void setComment(java.lang.String newComment)
```
    This method sets the order comment.
    
    Parameters:
    
    newComment - the order comment
  - setCurrency
```
public void setCurrency(java.lang.String newCurrency)
```
    This method sets the order currency.
    
    Parameters:
    
    newCurrency - the new currency used to calculate the order
  - setMessageId
```
public void setMessageId(java.lang.String aMessageId)
```
    This method sets the messageId of the order
    
    Parameters:
    
    aMessageId - this field is mapped to the payloadID in the actual XML message
  - setOrderDate
```
public void setOrderDate(java.util.Date newOrderDate)
```
    This method sets the order date.
    
    Parameters:
    
    newOrderDate - date when this order is created
  - setOrderId
```
public void setOrderId(java.lang.String newOrderId)
```
    This method sets the order identification number.
    
    Parameters:
    
    newOrderId - the ID identifying the current order
  - setOrderStatusUrl
```
public void setOrderStatusUrl(java.lang.String newOrderStatusUrl)
```
    This method sets the URL to post the order status.
    
    Parameters:
    
    newOrderStatusUrl - the URL to post the order status
  - setOrderType
```
public void setOrderType(java.lang.String newOrderType)
```
    This method sets the order type.
    
    Parameters:
    
    newOrderType - the code identifying the order type
  - setPayMethod
```
public void setPayMethod(PaymentInfo newPayMethod)
```
    This method sets the payment method.
    
    Parameters:
    
    newPayMethod - the payment method information
  - setShipModeId
```
public void setShipModeId(java.lang.String shipmodeId)
```
    This method sets the order ship mode ID.
    
    Parameters:
    
    shipmodeId - the code identifying the shipping mode
  - setShippingInfo
```
public void setShippingInfo(ShippingInfo newShippingInfo)
```
    This method sets the order shipping information.
    
    Parameters:
    
    newShippingInfo - the shipping information
  - setShipTo
```
public void setShipTo(Address newShipTo)
```
    This method sets the order shiping address.
    
    Parameters:
    
    newShipTo - the new shipping address
  - setTaxInfo
```
public void setTaxInfo(TaxInfo newTaxInfo)
```
    This method sets the order tax information.
    
    Parameters:
    
    newTaxInfo - the tax information
  - setTotalAmount
```
public void setTotalAmount(java.math.BigDecimal newTotalAmount)
```
    This method sets the total order amount.
    
    Parameters:
    
    newTotalAmount - the total amount

Methods inherited from class java.lang.Object

COPYRIGHT

PurchaseOrderHeader

getBillTo

getComment

getCurrency

getMessageId

getOrderDate

getOrderId

getOrderStatusUrl

getOrderType

getPayMethod

getShipModeId

getShippingInfo

getShipTo

getTaxInfo

getTotalAmount

setBillTo

setComment

setCurrency

setMessageId

setOrderDate

setOrderId

setOrderStatusUrl

setOrderType

setPayMethod

setShipModeId

setShippingInfo

setShipTo

setTaxInfo

setTotalAmount