Changes since
the last release

com.ebay.soap.eBLBaseComponents
Enum OrderStatusCodeType

java.lang.Object
  extended by java.lang.Enum<OrderStatusCodeType>
      extended by com.ebay.soap.eBLBaseComponents.OrderStatusCodeType
All Implemented Interfaces:
Serializable, Comparable<OrderStatusCodeType>

public enum OrderStatusCodeType
extends Enum<OrderStatusCodeType>

Java class for OrderStatusCodeType.

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

 <simpleType name="OrderStatusCodeType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="Active"/>
     <enumeration value="Inactive"/>
     <enumeration value="Completed"/>
     <enumeration value="Cancelled"/>
     <enumeration value="Shipped"/>
     <enumeration value="Default"/>
     <enumeration value="Authenticated"/>
     <enumeration value="InProcess"/>
     <enumeration value="Invalid"/>
     <enumeration value="CustomCode"/>
     <enumeration value="All"/>
     <enumeration value="CancelPending"/>
   </restriction>
 </simpleType>
 
Note: Per JAXB standards, underscores are added to separate words in enumerations (e.g., PayPal becomes PAY_PAL).


Enum Constant Summary
ACTIVE
          This value indicates that the cart is active.
ALL
          This value is passed into the OrderStatus of GetOrders to retrieve order in all states.
AUTHENTICATED
          This value indicates that the cart was authenticated.
CANCEL_PENDING
          This value indicates that a buyer has initiated a cancellation request on the order.
CANCELLED
          This value indicates that the cart was cancelled.
COMPLETED
          This value indicates that the order is completed.
CUSTOM_CODE
          Reserved for internal or future use.
DEFAULT
          This value indicates that the order is in default status.
IN_PROCESS
          This value indicates that processing of the buyer's cart has been initiated, but is not yet complete.
INACTIVE
          This value indicates that the cart is inactive.
INVALID
          This value indicates that the cart is invalid, or no longer exists.
SHIPPED
          This enumeration value is no longer applicable since this value is only applicable for Half.com listings, and API support for Half.com listings is being deprecated.
 
Method Summary
static OrderStatusCodeType fromValue(String v)
           
 String value()
           
static OrderStatusCodeType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static OrderStatusCodeType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ACTIVE

public static final OrderStatusCodeType ACTIVE
This value indicates that the cart is active. The 'Active' state is the only order state in which order line items can still be added, removed, or updated in the cart.


INACTIVE

public static final OrderStatusCodeType INACTIVE
This value indicates that the cart is inactive.


COMPLETED

public static final OrderStatusCodeType COMPLETED
This value indicates that the order is completed.


CANCELLED

public static final OrderStatusCodeType CANCELLED
This value indicates that the cart was cancelled.


SHIPPED

public static final OrderStatusCodeType SHIPPED
This enumeration value is no longer applicable since this value is only applicable for Half.com listings, and API support for Half.com listings is being deprecated.


DEFAULT

public static final OrderStatusCodeType DEFAULT
This value indicates that the order is in default status.


AUTHENTICATED

public static final OrderStatusCodeType AUTHENTICATED
This value indicates that the cart was authenticated.


IN_PROCESS

public static final OrderStatusCodeType IN_PROCESS
This value indicates that processing of the buyer's cart has been initiated, but is not yet complete.


INVALID

public static final OrderStatusCodeType INVALID
This value indicates that the cart is invalid, or no longer exists.


CUSTOM_CODE

public static final OrderStatusCodeType CUSTOM_CODE
Reserved for internal or future use.


ALL

public static final OrderStatusCodeType ALL
This value is passed into the OrderStatus of GetOrders to retrieve order in all states. This is the default value.


CANCEL_PENDING

public static final OrderStatusCodeType CANCEL_PENDING
This value indicates that a buyer has initiated a cancellation request on the order. If a seller sees an order in this state, that seller must either approve or reject the cancellation request through My eBay Web flows or through the Post-Order API cancellation calls.

This CancelPending value can be used as a filter in the GetOrders call request to discover recent buyer-initiated cancellations.

Method Detail

values

public static OrderStatusCodeType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (OrderStatusCodeType c : OrderStatusCodeType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static OrderStatusCodeType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

value

public String value()

fromValue

public static OrderStatusCodeType fromValue(String v)

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.