com.lmax.api.orderbook
Interface Instrument


public interface Instrument

Contains the meta-data for an instrument (Security Definition).


Method Summary
 CalendarInfo getCalendar()
          Get all date and time related information for the instrument.
 CommercialInfo getCommercial()
          Get information relating to the commercial agreements for this instrument.
 ContractInfo getContract()
          Get information relating to the contract for this instrument.
 long getId()
          Get the id of the instrument, also used a key for the order book on order requests, etc.
 java.lang.String getName()
          Get the name of the instrument, this is same value that is displayed on the Lmax Trader UI.
 OrderBookInfo getOrderBook()
          Get information relating the behaviour of the order book.
 RiskInfo getRisk()
          Get all of the information relating to risk for this instrument.
 UnderlyingInfo getUnderlying()
          Get information about the underlying instrument.
 

Method Detail

getId

long getId()
Get the id of the instrument, also used a key for the order book on order requests, etc.

Returns:
id.

getName

java.lang.String getName()
Get the name of the instrument, this is same value that is displayed on the Lmax Trader UI.

Returns:
name of the instrument.

getUnderlying

UnderlyingInfo getUnderlying()
Get information about the underlying instrument.

Returns:
underlying info.

getCalendar

CalendarInfo getCalendar()
Get all date and time related information for the instrument.

Returns:
calendar.

getRisk

RiskInfo getRisk()
Get all of the information relating to risk for this instrument.

Returns:
risk.

getOrderBook

OrderBookInfo getOrderBook()
Get information relating the behaviour of the order book.

Returns:
order book.

getContract

ContractInfo getContract()
Get information relating to the contract for this instrument.

Returns:
contract.

getCommercial

CommercialInfo getCommercial()
Get information relating to the commercial agreements for this instrument.

Returns:
commercial info.