com.lmax.api.orderbook
Class SearchInstrumentRequest

java.lang.Object
  extended by com.lmax.api.orderbook.SearchInstrumentRequest
All Implemented Interfaces:
com.lmax.api.internal.Request

public class SearchInstrumentRequest
extends java.lang.Object
implements com.lmax.api.internal.Request

An instrument search request.


Constructor Summary
SearchInstrumentRequest(java.lang.String queryString)
          Construct a request for a security definition.
SearchInstrumentRequest(java.lang.String queryString, long offsetInstrumentId)
          Construct a request for a security definition.
 
Method Summary
 java.lang.String getUri()
          The URI to send the instrument search request to.
 void writeTo(com.lmax.api.internal.xml.StructuredWriter writer)
          Internal: Output this request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchInstrumentRequest

public SearchInstrumentRequest(java.lang.String queryString)
Construct a request for a security definition. Uses a query string that provides flexible query mechanism. There are 2 main forms of the query string to find a specific instrument the "id: (instrumentId)" form can be used. To do a general search, use a term such as "CURRENCY", which will find all of the currency instruments. A search term like "UK" will find all of the instruments that have "UK" in the name.

Parameters:
queryString - the query string.

SearchInstrumentRequest

public SearchInstrumentRequest(java.lang.String queryString,
                               long offsetInstrumentId)
Construct a request for a security definition. Uses a query string that provides flexible query mechanism. There are 2 main forms of the query string to find a specific instrument the "id: (instrumentId)" form can be used. To do a general search, use a term such as "CURRENCY", which will find all of the currency instruments. A search term like "UK" will find all of the instruments that have "UK" in the name.

Parameters:
queryString - the query string.
offsetInstrumentId - last instrument id returned in alphabetical order.
Method Detail

getUri

public java.lang.String getUri()
The URI to send the instrument search request to.

Specified by:
getUri in interface com.lmax.api.internal.Request
Returns:
The URI to send the instrument search request to.

writeTo

public void writeTo(com.lmax.api.internal.xml.StructuredWriter writer)
Internal: Output this request.

Specified by:
writeTo in interface com.lmax.api.internal.Request
Parameters:
writer - The destination for the content of this request