|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<OrderStatusCodeType>
com.ebay.soap.eBLBaseComponents.OrderStatusCodeType
public 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 order is not yet complete. |
|
ALL
This enumeration value is passed into the OrderStatus of GetOrders to retrieve orders in all states. |
|
AUTHENTICATED
This enumeration value is no longer applicable and should not be used as an OrderStatus value in the GetOrders request payload. |
|
CANCEL_PENDING
This value indicates that a buyer has initiated a cancellation request on the order. |
|
CANCELLED
This value indicates that the order has been cancelled. |
|
COMPLETED
This value indicates that the order is paid for and complete. |
|
CUSTOM_CODE
Reserved for internal or future use. |
|
DEFAULT
This value is not used. |
|
IN_PROCESS
This enumeration value indicates that the order is currently in the state of being processed, but is not yet complete. |
|
INACTIVE
This value can be used a filter value in the OrderStatus field, and if used, all inactive orders will be returned. |
|
INVALID
This enumeration value is no longer applicable and should not be used as an OrderStatus value in the GetOrders request payload. |
|
SHIPPED
This enumeration value was only used for the deprecated Half.com site, so is no longer applicable and should not be used as an OrderStatus value in the GetOrders request payload. |
Method Summary | |
---|---|
static OrderStatusCodeType |
fromValue(java.lang.String v)
|
java.lang.String |
value()
|
static OrderStatusCodeType |
valueOf(java.lang.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 |
---|
public static final OrderStatusCodeType ACTIVE
Active
state means that the buyer has not initiated payment for the order. While an order is in this state, it can be combined into a Combined Invoice, a buyer can request a cancellation, and/or a seller can update payment details (including a change in order price) or shipping details (including shipping cost and shipping service).
public static final OrderStatusCodeType INACTIVE
public static final OrderStatusCodeType COMPLETED
Completed
state means that no other changes to the order can be made.
public static final OrderStatusCodeType CANCELLED
public static final OrderStatusCodeType SHIPPED
public static final OrderStatusCodeType DEFAULT
public static final OrderStatusCodeType AUTHENTICATED
public static final OrderStatusCodeType IN_PROCESS
public static final OrderStatusCodeType INVALID
public static final OrderStatusCodeType CUSTOM_CODE
public static final OrderStatusCodeType ALL
public static final OrderStatusCodeType CANCEL_PENDING
Method Detail |
---|
public static OrderStatusCodeType[] values()
for (OrderStatusCodeType c : OrderStatusCodeType.values()) System.out.println(c);
public static OrderStatusCodeType valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic java.lang.String value()
public static OrderStatusCodeType fromValue(java.lang.String v)
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
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.