com.google.checkout.orderprocessing.lineitem
Class ShipItemsRequest

java.lang.Object
  extended by com.google.checkout.AbstractCheckoutRequest
      extended by com.google.checkout.orderprocessing.AbstractOrderProcessingRequest
          extended by com.google.checkout.orderprocessing.lineitem.ShipItemsRequest

public class ShipItemsRequest
extends AbstractOrderProcessingRequest

This class contains methods that construct <ship-items> API requests.

Author:
Charles Dang (cdang@google.com)

Field Summary
 
Fields inherited from class com.google.checkout.AbstractCheckoutRequest
merchantInfo
 
Constructor Summary
ShipItemsRequest(MerchantInfo merchantInfo)
          Constructor which takes an instance of MerchantInfo.
ShipItemsRequest(MerchantInfo merchantInfo, java.lang.String googleOrderNumber)
          Constructor which takes an instance of MerchantInfo and the Google order number.
 
Method Summary
 void addItemShippingInformation(java.lang.String merchantItemId, java.lang.String carrier, java.lang.String trackingNumber)
          Add the item shipping information.
 void addItemShippingInformation(java.lang.String merchantItemId, TrackingData[] trackingData)
          Add the item shipping information.
 boolean isSendEmail()
          True if an email is to be sent to the buyer.
 void setSendEmail(boolean sendEmail)
          True if an email is to be sent to the buyer.
 
Methods inherited from class com.google.checkout.orderprocessing.AbstractOrderProcessingRequest
getGoogleOrderNo, getGoogleOrderNumber, setGoogleOrderNo, setGoogleOrderNumber
 
Methods inherited from class com.google.checkout.AbstractCheckoutRequest
getDocument, getPostUrl, getRoot, getXml, getXmlPretty, send
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ShipItemsRequest

public ShipItemsRequest(MerchantInfo merchantInfo)
Constructor which takes an instance of MerchantInfo.

Parameters:
merchantInfo - The merchant's information

ShipItemsRequest

public ShipItemsRequest(MerchantInfo merchantInfo,
                        java.lang.String googleOrderNumber)
                 throws CheckoutException
Constructor which takes an instance of MerchantInfo and the Google order number.

Parameters:
merchantInfo - The merchant's information.
googleOrderNumber - The Google order number.
Throws:
CheckoutException
Method Detail

isSendEmail

public boolean isSendEmail()
True if an email is to be sent to the buyer. This is the value of the <send-email> tag.

Returns:
The boolean value.

setSendEmail

public void setSendEmail(boolean sendEmail)
True if an email is to be sent to the buyer. This is the value of the <send-email> tag.

Parameters:
sendEmail - The boolean value.

addItemShippingInformation

public void addItemShippingInformation(java.lang.String merchantItemId,
                                       java.lang.String carrier,
                                       java.lang.String trackingNumber)
Add the item shipping information.

Parameters:
merchantItemId - The merchant's item id.
carrier - The carrier that will ship the items.
trackingNumber - The tracking number of the order.

addItemShippingInformation

public void addItemShippingInformation(java.lang.String merchantItemId,
                                       TrackingData[] trackingData)
Add the item shipping information.

Parameters:
merchantItemId - The merchant's item id.
trackingData - The tracking data.
See Also:
TrackingData