Package tech.cassandre.trading.bot.dto.trade

Enum OrderStatusDTO

java.lang.Object

java.lang.Enum<OrderStatusDTO>

tech.cassandre.trading.bot.dto.trade.OrderStatusDTO

All Implemented Interfaces:

Serializable, Comparable<OrderStatusDTO>

public enum OrderStatusDTO
extends Enum<OrderStatusDTO>

Order status for OrderDTO.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELED	Removed from order book at exchange.
CLOSED	Order has been either filled or cancelled.
EXPIRED	Order has expired it's time to live or trading session and been removed from order book.
FILLED	Fully match against opposite order on order book at exchange.
NEW	Initial order when placed on the order book at exchange.
OPEN	Order is open and waiting to be filled.
PARTIALLY_CANCELED	Order partially canceled at exchange.
PARTIALLY_FILLED	Partially match against opposite order on order book at exchange.
PENDING_CANCEL	Waiting to be removed from order book at exchange.
PENDING_NEW	Initial order when instantiated.
PENDING_REPLACE	Waiting to be replaced by another order on order book at exchange.
REJECTED	Order has been rejected by exchange and not place on order book.
REPLACED	Order has been replaced by another order on order book at exchange.
STOPPED	Order has been triggered at stop price.
UNKNOWN	The exchange returned a state which is not in the exchange's API documentation.

Method Summary

Modifier and Type	Method	Description
boolean	isFinal()	Returns true for final.
boolean	isInError()	Returns true if the status indicates an error.
boolean	isOpen()	Returns true when open.
static OrderStatusDTO	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OrderStatusDTO[]	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

PENDING_NEW

public static final OrderStatusDTO PENDING_NEW

Initial order when instantiated.

NEW

public static final OrderStatusDTO NEW

Initial order when placed on the order book at exchange.

PARTIALLY_FILLED

public static final OrderStatusDTO PARTIALLY_FILLED

Partially match against opposite order on order book at exchange.

FILLED

public static final OrderStatusDTO FILLED

Fully match against opposite order on order book at exchange.

PENDING_CANCEL

public static final OrderStatusDTO PENDING_CANCEL

Waiting to be removed from order book at exchange.

PARTIALLY_CANCELED

public static final OrderStatusDTO PARTIALLY_CANCELED

Order partially canceled at exchange.

CANCELED

public static final OrderStatusDTO CANCELED

Removed from order book at exchange.

PENDING_REPLACE

public static final OrderStatusDTO PENDING_REPLACE

Waiting to be replaced by another order on order book at exchange.

REPLACED

public static final OrderStatusDTO REPLACED

Order has been replaced by another order on order book at exchange.

STOPPED

public static final OrderStatusDTO STOPPED

Order has been triggered at stop price.

REJECTED

public static final OrderStatusDTO REJECTED

Order has been rejected by exchange and not place on order book.

EXPIRED

public static final OrderStatusDTO EXPIRED

Order has expired it's time to live or trading session and been removed from order book.

OPEN

public static final OrderStatusDTO OPEN

Order is open and waiting to be filled.

CLOSED

public static final OrderStatusDTO CLOSED

Order has been either filled or cancelled.

UNKNOWN

public static final OrderStatusDTO UNKNOWN

The exchange returned a state which is not in the exchange's API documentation. The state of the order cannot be confirmed.

Method Detail

values

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

Returns:

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

valueOf

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

isFinal

public final boolean isFinal()

Returns true for final.

Returns:

Returns true for final

isInError

public final boolean isInError()

Returns true if the status indicates an error.

Returns:

Returns true for final

isOpen

public final boolean isOpen()

Returns true when open.

Returns:

Returns true when open