BlotterItem is the data type representing a single item on the blotter. It is identified by the uniqueId passed into the constructor. It provides methods for setting its fields. More...
Public Member Functions | |
BlotterItem (string uniqueId) | |
virtual string | GetField (string name) |
virtual void | SetField (string name, string value) |
virtual void | SetFields (IDictionary< string, string > fieldMap) |
virtual void | SetParent (Caplin.DataSource.Blotter.BlotterItem parentBlotterItem) |
virtual void | SetParentItem (Caplin.DataSource.Blotter.BlotterItem parentItem) |
virtual Caplin.XLang.Container.RecordItem | ToRecordItem (Caplin.DataSource.Blotter.BlotterConfiguration configuration, string username, string parameters) |
override string | ToString () |
Properties | |
virtual IDictionary< string, string > | Fields [get] |
virtual string | HexEncodedUniqueId [get] |
virtual Caplin.DataSource.Blotter.BlotterItem | Parent [get] |
virtual string | UniqueId [get] |
BlotterItem is the data type representing a single item on the blotter. It is identified by the uniqueId passed into the constructor. It provides methods for setting its fields.
BlotterItems are passed into the IBlotterChannel.SendBlotterItem(BlotterItem ) and IBlotterChannel.SendBlotterItems(java.util.List ) methods on the IBlotterChannel received on IBlotterApplicationListener callbacks.
The uniqueId replaces the 'i' in the itemNamespace passed into the BlotterConfiguration to create the record subject for this item.
BlotterItems can be reused in different IBlotterChannels as they are completely separate from them.
|
inline |
uniqueId | Unique identifier for this blotter item. This id is used when removing items from the IBlotterChannel |
and in the callback in IBlotterChannelListener.
|
inlinevirtual |
name | Key associated with a value |
|
inlinevirtual |
name | Field name associate with a value. These must be present in the fields.conf used to configure the DataSource. |
value | Value to send associated with this field name |
|
inlinevirtual |
fieldMap | Map of fields and values for this BlotterItem. The field names must be present in the fields.conf used to configure the DataSource. |
|
inlinevirtual |
parentBlotterItem | The parent of this BlotterItem. To change the parent of the BlotterItem, the item must be removed and resent. |
|
inline |
String containing this BlotterItem's uniqueId and fields.
|
get |
A map containing all fields present on this BlotterItem.
|
get |
uniqueId The uniqueId this BlotterItem was instantiated with.