com.lmax.api.order
Interface Order


public interface Order

The order.


Method Summary
 long getAccountId()
          The if of the account which placed the order.
 FixedPointNumber getCancelledQuantity()
          The amount of the order which has been cancelled.
 FixedPointNumber getCommission()
          The total commission charged on the order.
 FixedPointNumber getFilledQuantity()
          The amount of the order which has been filled (matched).
 java.lang.String getInstructionId()
          The id of the client correlation ID of the last modification to this order.
 long getInstrumentId()
          The id of the instrument on which this order was placed.
 FixedPointNumber getLimitPrice()
          Return the limit price of the order.
 java.lang.String getOrderId()
          The id of the order.
 OrderType getOrderType()
          Denotes the type of the of the order.
 java.lang.String getOriginalInstructionId()
          The id of the instruction which placed the order.
 FixedPointNumber getQuantity()
          The total quantity of the order.
 FixedPointNumber getStopLossOffset()
          The distance from the stop reference price at which the stop Loss Order will be placed.
 FixedPointNumber getStopProfitOffset()
          The distance from the stop reference price at which the stop Profit Order will rest on the book.
 FixedPointNumber getStopReferencePrice()
          The price at which the stop loss and stop profit offsets are considered relative too.
 TimeInForce getTimeInForce()
          Denotes the lifespan of the the order.
 

Method Detail

getInstructionId

java.lang.String getInstructionId()
The id of the client correlation ID of the last modification to this order.

Returns:
the Instruction Id

getOriginalInstructionId

java.lang.String getOriginalInstructionId()
The id of the instruction which placed the order.

Returns:
the Original Instruction Id

getOrderId

java.lang.String getOrderId()
The id of the order.

Returns:
the id of the order

getInstrumentId

long getInstrumentId()
The id of the instrument on which this order was placed.

Returns:
the instrument Id

getAccountId

long getAccountId()
The if of the account which placed the order.

Returns:
the account id

getOrderType

OrderType getOrderType()
Denotes the type of the of the order.

Returns:
the order type

getTimeInForce

TimeInForce getTimeInForce()
Denotes the lifespan of the the order.

Returns:
the time in force for the order

getQuantity

FixedPointNumber getQuantity()
The total quantity of the order.

Returns:
the quantity of the order

getFilledQuantity

FixedPointNumber getFilledQuantity()
The amount of the order which has been filled (matched).

Returns:
the current filled quantity

getLimitPrice

FixedPointNumber getLimitPrice()
Return the limit price of the order.

Returns:
limit price or null if the order type is not Limit.

getStopReferencePrice

FixedPointNumber getStopReferencePrice()
The price at which the stop loss and stop profit offsets are considered relative too.

Returns:
The price stops are considered relative too.

getStopLossOffset

FixedPointNumber getStopLossOffset()
The distance from the stop reference price at which the stop Loss Order will be placed.

Returns:
The size of the offset from the stop reference price.

getStopProfitOffset

FixedPointNumber getStopProfitOffset()
The distance from the stop reference price at which the stop Profit Order will rest on the book.

Returns:
The size of the offset from the stop reference price.

getCancelledQuantity

FixedPointNumber getCancelledQuantity()
The amount of the order which has been cancelled.

Returns:
The quantity of the order which has been cancelled.

getCommission

FixedPointNumber getCommission()
The total commission charged on the order.

Returns:
The commission charged.