com.lmax.api.marketdata
Class TopOfBookHistoricMarketDataRequest

java.lang.Object
  extended by com.lmax.api.marketdata.TopOfBookHistoricMarketDataRequest
All Implemented Interfaces:
com.lmax.api.internal.Request, HistoricMarketDataRequest

public class TopOfBookHistoricMarketDataRequest
extends java.lang.Object
implements HistoricMarketDataRequest

Request historic order book prices and quantities.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.lmax.api.marketdata.HistoricMarketDataRequest
HistoricMarketDataRequest.Format, HistoricMarketDataRequest.Resolution
 
Constructor Summary
TopOfBookHistoricMarketDataRequest(java.lang.String instructionId, long instrumentId, java.util.Date from, java.util.Date to, HistoricMarketDataRequest.Format format)
          Request historic prices and quantities for the given order book.
 
Method Summary
 java.lang.String getUri()
          Get the URI for the request.
 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

TopOfBookHistoricMarketDataRequest

public TopOfBookHistoricMarketDataRequest(java.lang.String instructionId,
                                          long instrumentId,
                                          java.util.Date from,
                                          java.util.Date to,
                                          HistoricMarketDataRequest.Format format)
Request historic prices and quantities for the given order book.

Parameters:
instructionId - Unique ID for this request
instrumentId - The ID of the instrument to return the data for
from - The date and time of the start of the range
to - The date and time of the end of the range
format - Protocol e.g CSV
Method Detail

getUri

public java.lang.String getUri()
Get the URI for the request.

Specified by:
getUri in interface com.lmax.api.internal.Request
Returns:
the URI.

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