com.lmax.api.order
Interface OrderSpecification

All Superinterfaces:
com.lmax.api.internal.Request
All Known Implementing Classes:
com.lmax.api.internal.order.AbstractOrderSpecification, LimitOrderSpecification, MarketOrderSpecification

public interface OrderSpecification
extends com.lmax.api.internal.Request

Order Request.


Method Summary
 void setInstructionId(java.lang.String instructionId)
          Set the user correlation ID for this order.
 void setInstrumentId(long instrumentId)
          Set the instrument for the order.
 void setQuantity(FixedPointNumber quantity)
          Set the quantity of the order specification to the specified value.
 void setStopLossPriceOffset(FixedPointNumber stopLossPriceOffset)
          Set the stop loss price offset for the order.
 void setStopProfitPriceOffset(FixedPointNumber stopProfitPriceOffset)
          Set the stop profit price offset for the order.
 void setTimeInForce(TimeInForce timeInForce)
          Set the time in force policy for the order.
 
Methods inherited from interface com.lmax.api.internal.Request
getUri, writeTo
 

Method Detail

setInstructionId

void setInstructionId(java.lang.String instructionId)
Set the user correlation ID for this order. This must be unique for each new order that is placed, and will be the instructionId needed if the order is to be cancelled or amended.

Parameters:
instructionId - The ID to associate with this order.

setQuantity

void setQuantity(FixedPointNumber quantity)
Set the quantity of the order specification to the specified value. This allows you to place multiple orders with different quantities using one order specification.

Parameters:
quantity - New quantity for the order specification.

setStopLossPriceOffset

void setStopLossPriceOffset(FixedPointNumber stopLossPriceOffset)
Set the stop loss price offset for the order.

Parameters:
stopLossPriceOffset - if set to null no stop loss will be in force.

setStopProfitPriceOffset

void setStopProfitPriceOffset(FixedPointNumber stopProfitPriceOffset)
Set the stop profit price offset for the order.

Parameters:
stopProfitPriceOffset - if set to null no stop profit will be in force.

setTimeInForce

void setTimeInForce(TimeInForce timeInForce)
Set the time in force policy for the order.

Parameters:
timeInForce - The time in force policy for the order.

setInstrumentId

void setInstrumentId(long instrumentId)
Set the instrument for the order.

Parameters:
instrumentId - The instrument id for the order.