OrderState.java

package org.cryptocoinpartners.enumeration;

/**
 * @author Mike Olson
 * @author Tim Olson
 */
public enum OrderState {
    /** the Order is created but it has not been sent to an Exchange yet.  Subsequent states may be: ROUTED, PLACED, CANCELLING, EXPIRED, REJECTED */
    NEW,
    /** the Order is created but it has not been sent to an Exchange yet.  Subsequent states may be: ROUTED, PLACED, CANCELLING, EXPIRED, REJECTED */
    TRIGGER,
    /** Indicates that a specifc order has is awaiting a trigger before being sent to exchange.  Subsequent states may be: PLACED, CANCELLING, EXPIRED, REJECTED */
    ROUTED,
    /** At least part of the Order has been routed to an Exchange.  Subsequent states may be: PARTFILLED, FILLED, CANCELLING, EXPIRED, REJECTED  */
    PLACED,
    /** Some of the requested volume has been filled, but not all of it.  Subsequent states may be: FILLED, CANCELLING, EXPIRED */
    PARTFILLED,
    /** All of the Order's volume has been filled.  This is a terminal state. */
    FILLED,
    /** A cancellation request has been sent to the Exchange.  Subsequent states may be: CANCELLED, EXPIRED */
    CANCELLING,
    /** The Exchange has confirmed a cancellation request.  This is a terminal state. */
    CANCELLED,
    /** If the cancellation was due to expiry, this is the terminal state instead of CANCELLED */
    EXPIRED,
    /** The Order cannot be filled as specified.  This is a terminal state.  */
    REJECTED,

    ;

    /** return true iff NEW || ROUTED || PLACED || PARTFILLED */
    public boolean isOpen() {
        return this == OrderState.NEW || this == OrderState.TRIGGER || this == OrderState.ROUTED || this == OrderState.PLACED || this == OrderState.PARTFILLED;
    }

    public boolean isCancelled() {
        return this == OrderState.CANCELLED;
    }

    public boolean isNew() {
        return this == OrderState.NEW;
    }

    public boolean isTrigger() {
        return this == OrderState.TRIGGER;
    }

    public boolean isRouted() {
        return this == OrderState.ROUTED;
    }

    public boolean isFilled() {
        return this == OrderState.FILLED;
    }

    public boolean isExpired() {
        return this == OrderState.EXPIRED;
    }

    public boolean isRejected() {
        return this == OrderState.REJECTED;
    }

    public boolean isPartfilled() {
        return this == OrderState.PARTFILLED;
    }

    public boolean isPlaced() {
        return this == OrderState.PLACED;
    }

    public boolean isCancelling() {
        return this == OrderState.CANCELLING;
    }

}