org.otfeed.command
Class SnapshotCommand

java.lang.Object
  org.otfeed.command.SnapshotCommand

All Implemented Interfaces:

ICommand

public final class SnapshotCommand
extends java.lang.Object
implements ICommand

Request for the quote snapshot. A snapshot is the latest event of the given type.

Generates quote, trade, marker-maker quote, and bbo events.

Constructor Summary

SnapshotCommand()
Default construtor.

SnapshotCommand(java.lang.String exchangeCode, java.lang.String symbolCode)
Creates new snapshot command, initializing all its properties, except volumeStyle, which defaults to COMPOUND, and delegates.

SnapshotCommand(java.lang.String exchangeCode, java.lang.String symbolCode, VolumeStyleEnum volumeStyle)
Creates new snapshot command, initializing all its properties, except delegates.

Method Summary

IDataDelegate<OTBBO>	getBboDelegate()
ICompletionDelegate	getCompletionDelegate() Option delegate to watch stream completion event.
java.lang.String	getExchangeCode() Exchange code.
IDataDelegate<OTMMQuote>	getMmQuoteDelegate()
IDataDelegate<OTQuote>	getQuoteDelegate()
java.lang.String	getSymbolCode() Symbol code.
IDataDelegate<OTTrade>	getTradeDelegate()
VolumeStyleEnum	getVolumeStyle() Specifies whether quote events will contain individual volume, or compound volume.
void	setBboDelegate(IDataDelegate<OTBBO> val)
void	setCompletionDelegate(ICompletionDelegate val) Sets completion delegate.
void	setExchangeCode(java.lang.String exchangeCode) Sets the exchange code.
void	setMmQuoteDelegate(IDataDelegate<OTMMQuote> val)
void	setQuoteDelegate(IDataDelegate<OTQuote> val)
void	setSymbolCode(java.lang.String val) Sets symbol code.
void	setTradeDelegate(IDataDelegate<OTTrade> val)
void	setVolumeStyle(VolumeStyleEnum val) Sets volume reporting style.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnapshotCommand

public SnapshotCommand(java.lang.String exchangeCode,
                       java.lang.String symbolCode,
                       VolumeStyleEnum volumeStyle)

Creates new snapshot command, initializing all its properties, except delegates.

Parameters:

exchangeCode - exchange code.

symbolCode - symbol code.

volumeStyle - volume reporting style.

SnapshotCommand

public SnapshotCommand()

Default construtor. Initializes volumeStyle property to its default value of COMPOUND. Other properties must be set explicitly before using this object.

SnapshotCommand

public SnapshotCommand(java.lang.String exchangeCode,
                       java.lang.String symbolCode)

Creates new snapshot command, initializing all its properties, except volumeStyle, which defaults to COMPOUND, and delegates.

Parameters:

exchangeCode - exchange code.

symbolCode - symbol code.

Method Detail

setVolumeStyle

public final void setVolumeStyle(VolumeStyleEnum val)

Sets volume reporting style.

Parameters:

val - volume style.

getQuoteDelegate

public IDataDelegate<OTQuote> getQuoteDelegate()

setQuoteDelegate

public void setQuoteDelegate(IDataDelegate<OTQuote> val)

getTradeDelegate

public IDataDelegate<OTTrade> getTradeDelegate()

setTradeDelegate

public void setTradeDelegate(IDataDelegate<OTTrade> val)

getMmQuoteDelegate

public IDataDelegate<OTMMQuote> getMmQuoteDelegate()

setMmQuoteDelegate

public void setMmQuoteDelegate(IDataDelegate<OTMMQuote> val)

getBboDelegate

public IDataDelegate<OTBBO> getBboDelegate()

setBboDelegate

public void setBboDelegate(IDataDelegate<OTBBO> val)

getVolumeStyle

public final VolumeStyleEnum getVolumeStyle()

Specifies whether quote events will contain individual volume, or compound volume. By default, COMPOUND volume is requested.

Returns:

volume style.

getExchangeCode

public final java.lang.String getExchangeCode()

Exchange code.

Returns:

exchange code.

setExchangeCode

public final void setExchangeCode(java.lang.String exchangeCode)

Sets the exchange code.

Parameters:

exchangeCode - exchange code.

getSymbolCode

public final java.lang.String getSymbolCode()

Symbol code.

Returns:

symbol code.

setSymbolCode

public final void setSymbolCode(java.lang.String val)

Sets symbol code.

Parameters:

val - symbol code.

getCompletionDelegate

public ICompletionDelegate getCompletionDelegate()

Option delegate to watch stream completion event.

Returns:

delegate.

setCompletionDelegate

public void setCompletionDelegate(ICompletionDelegate val)

Sets completion delegate.

Parameters:

val - delegate.