Changes since
the last release

com.ebay.soap.eBLBaseComponents
Class ShippingServiceOptionsType

java.lang.Object
  extended by com.ebay.soap.eBLBaseComponents.ShippingServiceOptionsType
All Implemented Interfaces:
java.io.Serializable

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

Container consisting of shipping costs and other details related to a domestic shipping service. An exception to the domestic shipping service rule is seen in the ShippingServiceSelected container returned under the Order and Transaction containers in order and order line item retrieval calls such as GetOrders or GetItemTransactions. In this scenario, the SelectedShippingService container consists of either domestic or international shipping service data, based on the selected service according to the buyer's shipping address.

If one or more international shipping services are provided, the seller must specify at least one domestic shipping service as well.

Note: For GetItemTransactions and GetSellerTransactions, this container does not return accurate shipping service and cost information for multiple line item orders. Use GetOrders instead, and provide the order's combined OrderID to retrieve this information.

Java class for ShippingServiceOptionsType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ShippingServiceOptionsType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="ShippingInsuranceCost" type="{urn:ebay:apis:eBLBaseComponents}AmountType" minOccurs="0"/>
         <element name="ShippingService" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="ShippingServiceCost" type="{urn:ebay:apis:eBLBaseComponents}AmountType" minOccurs="0"/>
         <element name="ShippingServiceAdditionalCost" type="{urn:ebay:apis:eBLBaseComponents}AmountType" minOccurs="0"/>
         <element name="ShippingServicePriority" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="ExpeditedService" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="ShippingTimeMin" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="ShippingTimeMax" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="ShippingSurcharge" type="{urn:ebay:apis:eBLBaseComponents}AmountType" minOccurs="0"/>
         <element name="FreeShipping" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="LocalPickup" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="ImportCharge" type="{urn:ebay:apis:eBLBaseComponents}AmountType" minOccurs="0"/>
         <element name="ShippingPackageInfo" type="{urn:ebay:apis:eBLBaseComponents}ShippingPackageInfoType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ShippingServiceCutOffTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="LogisticPlanType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <any/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:
Serialized Form

Field Summary
protected  java.util.List<java.lang.Object> any
           
protected  java.lang.Boolean expeditedService
           
protected  java.lang.Boolean freeShipping
           
protected  AmountType importCharge
           
protected  java.lang.Boolean localPickup
           
protected  java.lang.String logisticPlanType
           
protected  AmountType shippingInsuranceCost
           
protected  java.util.List<ShippingPackageInfoType> shippingPackageInfo
           
protected  java.lang.String shippingService
           
protected  AmountType shippingServiceAdditionalCost
           
protected  AmountType shippingServiceCost
           
protected  java.util.Calendar shippingServiceCutOffTime
           
protected  java.lang.Integer shippingServicePriority
           
protected  AmountType shippingSurcharge
           
protected  java.lang.Integer shippingTimeMax
           
protected  java.lang.Integer shippingTimeMin
           
 
Constructor Summary
ShippingServiceOptionsType()
           
 
Method Summary
protected  java.util.List<java.lang.Object> _getAny()
           
protected  java.util.List<ShippingPackageInfoType> _getShippingPackageInfo()
           
 java.lang.Object[] getAny()
           
 java.lang.Object getAny(int idx)
           
 int getAnyLength()
           
 AmountType getImportCharge()
          Gets the value of the importCharge property.
 java.lang.String getLogisticPlanType()
          Gets the value of the logisticPlanType property.
 AmountType getShippingInsuranceCost()
          Gets the value of the shippingInsuranceCost property.
 ShippingPackageInfoType[] getShippingPackageInfo()
           
 ShippingPackageInfoType getShippingPackageInfo(int idx)
           
 int getShippingPackageInfoLength()
           
 java.lang.String getShippingService()
          Gets the value of the shippingService property.
 AmountType getShippingServiceAdditionalCost()
          Gets the value of the shippingServiceAdditionalCost property.
 AmountType getShippingServiceCost()
          Gets the value of the shippingServiceCost property.
 java.util.Calendar getShippingServiceCutOffTime()
          Gets the value of the shippingServiceCutOffTime property.
 java.lang.Integer getShippingServicePriority()
          Gets the value of the shippingServicePriority property.
 AmountType getShippingSurcharge()
          Gets the value of the shippingSurcharge property.
 java.lang.Integer getShippingTimeMax()
          Gets the value of the shippingTimeMax property.
 java.lang.Integer getShippingTimeMin()
          Gets the value of the shippingTimeMin property.
 java.lang.Boolean isExpeditedService()
          Gets the value of the expeditedService property.
 java.lang.Boolean isFreeShipping()
          Gets the value of the freeShipping property.
 java.lang.Boolean isLocalPickup()
          Gets the value of the localPickup property.
 java.lang.Object setAny(int idx, java.lang.Object value)
           
 void setAny(java.lang.Object[] values)
           
 void setExpeditedService(java.lang.Boolean value)
          Sets the value of the expeditedService property.
 void setFreeShipping(java.lang.Boolean value)
          Sets the value of the freeShipping property.
 void setImportCharge(AmountType value)
          Sets the value of the importCharge property.
 void setLocalPickup(java.lang.Boolean value)
          Sets the value of the localPickup property.
 void setLogisticPlanType(java.lang.String value)
          Sets the value of the logisticPlanType property.
 void setShippingInsuranceCost(AmountType value)
          Sets the value of the shippingInsuranceCost property.
 ShippingPackageInfoType setShippingPackageInfo(int idx, ShippingPackageInfoType value)
           
 void setShippingPackageInfo(ShippingPackageInfoType[] values)
           
 void setShippingService(java.lang.String value)
          Sets the value of the shippingService property.
 void setShippingServiceAdditionalCost(AmountType value)
          Sets the value of the shippingServiceAdditionalCost property.
 void setShippingServiceCost(AmountType value)
          Sets the value of the shippingServiceCost property.
 void setShippingServiceCutOffTime(java.util.Calendar value)
          Sets the value of the shippingServiceCutOffTime property.
 void setShippingServicePriority(java.lang.Integer value)
          Sets the value of the shippingServicePriority property.
 void setShippingSurcharge(AmountType value)
          Sets the value of the shippingSurcharge property.
 void setShippingTimeMax(java.lang.Integer value)
          Sets the value of the shippingTimeMax property.
 void setShippingTimeMin(java.lang.Integer value)
          Sets the value of the shippingTimeMin property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

shippingInsuranceCost

protected AmountType shippingInsuranceCost

shippingService

protected java.lang.String shippingService

shippingServiceCost

protected AmountType shippingServiceCost

shippingServiceAdditionalCost

protected AmountType shippingServiceAdditionalCost

shippingServicePriority

protected java.lang.Integer shippingServicePriority

expeditedService

protected java.lang.Boolean expeditedService

shippingTimeMin

protected java.lang.Integer shippingTimeMin

shippingTimeMax

protected java.lang.Integer shippingTimeMax

shippingSurcharge

protected AmountType shippingSurcharge

freeShipping

protected java.lang.Boolean freeShipping

localPickup

protected java.lang.Boolean localPickup

importCharge

protected AmountType importCharge

shippingPackageInfo

protected java.util.List<ShippingPackageInfoType> shippingPackageInfo

shippingServiceCutOffTime

protected java.util.Calendar shippingServiceCutOffTime

logisticPlanType

protected java.lang.String logisticPlanType

any

protected java.util.List<java.lang.Object> any
Constructor Detail

ShippingServiceOptionsType

public ShippingServiceOptionsType()
Method Detail

getShippingInsuranceCost

public AmountType getShippingInsuranceCost()
Gets the value of the shippingInsuranceCost property.

Returns:
possible object is AmountType

setShippingInsuranceCost

public void setShippingInsuranceCost(AmountType value)
Sets the value of the shippingInsuranceCost property.

Parameters:
value - allowed object is AmountType

getShippingService

public java.lang.String getShippingService()
Gets the value of the shippingService property.

Returns:
possible object is String

setShippingService

public void setShippingService(java.lang.String value)
Sets the value of the shippingService property.

Parameters:
value - allowed object is String

getShippingServiceCost

public AmountType getShippingServiceCost()
Gets the value of the shippingServiceCost property.

Returns:
possible object is AmountType

setShippingServiceCost

public void setShippingServiceCost(AmountType value)
Sets the value of the shippingServiceCost property.

Parameters:
value - allowed object is AmountType

getShippingServiceAdditionalCost

public AmountType getShippingServiceAdditionalCost()
Gets the value of the shippingServiceAdditionalCost property.

Returns:
possible object is AmountType

setShippingServiceAdditionalCost

public void setShippingServiceAdditionalCost(AmountType value)
Sets the value of the shippingServiceAdditionalCost property.

Parameters:
value - allowed object is AmountType

getShippingServicePriority

public java.lang.Integer getShippingServicePriority()
Gets the value of the shippingServicePriority property.

Returns:
possible object is Integer

setShippingServicePriority

public void setShippingServicePriority(java.lang.Integer value)
Sets the value of the shippingServicePriority property.

Parameters:
value - allowed object is Integer

isExpeditedService

public java.lang.Boolean isExpeditedService()
Gets the value of the expeditedService property.

Returns:
possible object is Boolean

setExpeditedService

public void setExpeditedService(java.lang.Boolean value)
Sets the value of the expeditedService property.

Parameters:
value - allowed object is Boolean

getShippingTimeMin

public java.lang.Integer getShippingTimeMin()
Gets the value of the shippingTimeMin property.

Returns:
possible object is Integer

setShippingTimeMin

public void setShippingTimeMin(java.lang.Integer value)
Sets the value of the shippingTimeMin property.

Parameters:
value - allowed object is Integer

getShippingTimeMax

public java.lang.Integer getShippingTimeMax()
Gets the value of the shippingTimeMax property.

Returns:
possible object is Integer

setShippingTimeMax

public void setShippingTimeMax(java.lang.Integer value)
Sets the value of the shippingTimeMax property.

Parameters:
value - allowed object is Integer

getShippingSurcharge

public AmountType getShippingSurcharge()
Gets the value of the shippingSurcharge property.

Returns:
possible object is AmountType

setShippingSurcharge

public void setShippingSurcharge(AmountType value)
Sets the value of the shippingSurcharge property.

Parameters:
value - allowed object is AmountType

isFreeShipping

public java.lang.Boolean isFreeShipping()
Gets the value of the freeShipping property.

Returns:
possible object is Boolean

setFreeShipping

public void setFreeShipping(java.lang.Boolean value)
Sets the value of the freeShipping property.

Parameters:
value - allowed object is Boolean

isLocalPickup

public java.lang.Boolean isLocalPickup()
Gets the value of the localPickup property.

Returns:
possible object is Boolean

setLocalPickup

public void setLocalPickup(java.lang.Boolean value)
Sets the value of the localPickup property.

Parameters:
value - allowed object is Boolean

getImportCharge

public AmountType getImportCharge()
Gets the value of the importCharge property.

Returns:
possible object is AmountType

setImportCharge

public void setImportCharge(AmountType value)
Sets the value of the importCharge property.

Parameters:
value - allowed object is AmountType

getShippingPackageInfo

public ShippingPackageInfoType[] getShippingPackageInfo()
Returns:
array of ShippingPackageInfoType

getShippingPackageInfo

public ShippingPackageInfoType getShippingPackageInfo(int idx)
Returns:
one of ShippingPackageInfoType

getShippingPackageInfoLength

public int getShippingPackageInfoLength()

setShippingPackageInfo

public void setShippingPackageInfo(ShippingPackageInfoType[] values)
Parameters:
values - allowed objects are ShippingPackageInfoType

_getShippingPackageInfo

protected java.util.List<ShippingPackageInfoType> _getShippingPackageInfo()

setShippingPackageInfo

public ShippingPackageInfoType setShippingPackageInfo(int idx,
                                                      ShippingPackageInfoType value)
Parameters:
value - allowed object is ShippingPackageInfoType

getShippingServiceCutOffTime

public java.util.Calendar getShippingServiceCutOffTime()
Gets the value of the shippingServiceCutOffTime property.

Returns:
possible object is String

setShippingServiceCutOffTime

public void setShippingServiceCutOffTime(java.util.Calendar value)
Sets the value of the shippingServiceCutOffTime property.

Parameters:
value - allowed object is String

getLogisticPlanType

public java.lang.String getLogisticPlanType()
Gets the value of the logisticPlanType property.

Returns:
possible object is String

setLogisticPlanType

public void setLogisticPlanType(java.lang.String value)
Sets the value of the logisticPlanType property.

Parameters:
value - allowed object is String

getAny

public java.lang.Object[] getAny()
Returns:
array of Object Element

getAny

public java.lang.Object getAny(int idx)
Returns:
one of Object Element

getAnyLength

public int getAnyLength()

setAny

public void setAny(java.lang.Object[] values)
Parameters:
values - allowed objects are Object Element

_getAny

protected java.util.List<java.lang.Object> _getAny()

setAny

public java.lang.Object setAny(int idx,
                               java.lang.Object value)
Parameters:
value - allowed object is Object Element

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.