com.paypal.sdk.models

Enum OrderStatus

java.lang.Object

java.lang.Enum<OrderStatus>

com.paypal.sdk.models.OrderStatus

All Implemented Interfaces:

Serializable, Comparable<OrderStatus>

public enum OrderStatus
extends Enum<OrderStatus>

OrderStatus to be used.

Enum Constant Summary

Enum Constants

Enum Constant and Description
_UNKNOWN Unknown values will be mapped by this enum member
APPROVED The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment.
COMPLETED The intent of the Order was completed and a `payments` resource was created.
CREATED The order was created with the specified context.
PAYER_ACTION_REQUIRED The order requires an action from the payer (e.g.
SAVED The order was saved and persisted.
VOIDED All purchase units in the order are voided.

Method Summary

Modifier and Type	Method and Description
static OrderStatus	constructFromString(String toConvert) Returns the enum member associated with the given string value.
static OrderStatus	fromString(String toConvert) Returns the enum member associated with the given string value.
String	toString() Get string representation of this enum.
static List<String>	toValue(List<OrderStatus> toConvert) Convert list of OrderStatus values to list of string values.
String	value() Returns the string value associated with the enum member.
static OrderStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static OrderStatus[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CREATED

public static final OrderStatus CREATED

The order was created with the specified context.

SAVED

public static final OrderStatus SAVED

The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order.

APPROVED

public static final OrderStatus APPROVED

The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.

VOIDED

public static final OrderStatus VOIDED

All purchase units in the order are voided.

COMPLETED

public static final OrderStatus COMPLETED

The intent of the Order was completed and a `payments` resource was created. A completed Order may have authorized a payment, captured an authorized payment, or in some cases, the payment may have been declined. Please verify the payment status under purchase_unitsArray.payments before proceeding with Order fulfillment.

PAYER_ACTION_REQUIRED

public static final OrderStatus PAYER_ACTION_REQUIRED

The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app notification, etc).

_UNKNOWN

public static final OrderStatus _UNKNOWN

Unknown values will be mapped by this enum member

Method Detail

values

public static OrderStatus[] 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 (OrderStatus c : OrderStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static OrderStatus 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

constructFromString

public static OrderStatus constructFromString(String toConvert)
                                       throws IOException

Returns the enum member associated with the given string value.

Parameters:

toConvert - String value to get enum member.

Returns:

The enum member against the given string value.

Throws:

IOException - when provided value is not mapped to any enum member.

fromString

public static OrderStatus fromString(String toConvert)

Returns the enum member associated with the given string value.

Parameters:

toConvert - String value to get enum member.

Returns:

The enum member against the given string value.

value

public String value()

Returns the string value associated with the enum member.

Returns:

The string value against enum member.

toString

public String toString()

Get string representation of this enum.

Overrides:

toString in class Enum<OrderStatus>

toValue

public static List<String> toValue(List<OrderStatus> toConvert)

Convert list of OrderStatus values to list of string values.

Parameters:

toConvert - The list of OrderStatus values to convert.

Returns:

List of representative string values.