public interface RecordType2Message extends RecordMessage
Interface for populating Type 2 Record messages, adding fields by field name.
Type 2 data represents market depth, and an instance of an RecordType2Message
represents a market maker or level with an order book. Note that a Record with a given Subject
can contain Type 1, Type 2 and Type 3 data. For an illustration of how Type 2 data is structured
see the document DataSource Overview.
To construct a RecordType2Message
use the
MessageFactory
obtained from the
Publisher
interface; objects implementing
RecordType2Message
cannot be instantiated directly.
Modifier and Type | Method and Description |
---|---|
boolean |
getClearFlag()
Gets a value indicating whether all the Type2 data should be cleared.
|
boolean |
getDeleteEntryFlag()
Gets a value indicating whether this Type2 index should be deleted.
|
java.lang.String |
getType2Index()
Retrieves the Type2 index value.
|
java.lang.String |
getType2IndexField()
Retrieves the fieldname that is used for the Type2 index.
|
void |
setClearFlag(java.lang.Boolean clearFlag)
Sets a value indicating whether all Type2 data should be cleared.
|
void |
setDeleteEntryFlag(java.lang.Boolean deleteEntryFlag)
Sets a value indicating whether this Type2 index should be deleted.
|
addLatencyChainPoint, clearFields, containsField, getField, getFields, removeField, setField, setInitialLatencyChainTime
getMessageType, getSubject, isImage, setImage
java.lang.String getType2IndexField()
java.lang.String getType2Index()
boolean getDeleteEntryFlag()
True
if the Type2 index should be deleted; otherwise false
.void setDeleteEntryFlag(java.lang.Boolean deleteEntryFlag)
deleteEntryFlag
- True
if the Type2 index should be deleted; otherwise false
.boolean getClearFlag()
True
if all the Type2 data should be cleared; otherwise false
.void setClearFlag(java.lang.Boolean clearFlag)
clearFlag
- True
if all Type2 data should be cleared; otherwise false
.Please send bug reports and comments to Caplin support