DataSource Blotter.NET  6.2.3-304692
 All Classes Namespaces Functions Properties Pages
Public Member Functions | Properties | List of all members
Caplin.DataSource.Blotter.BlotterItem Class Reference

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]
 

Detailed Description

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.

Constructor & Destructor Documentation

Caplin.DataSource.Blotter.BlotterItem.BlotterItem ( string  uniqueId)
inline
Parameters
uniqueIdUnique identifier for this blotter item. This id is used when removing items from the IBlotterChannel

and in the callback in IBlotterChannelListener.

Member Function Documentation

virtual string Caplin.DataSource.Blotter.BlotterItem.GetField ( string  name)
inlinevirtual
Parameters
nameKey associated with a value
Returns
Value of this field
virtual void Caplin.DataSource.Blotter.BlotterItem.SetField ( string  name,
string  value 
)
inlinevirtual
Parameters
nameField name associate with a value. These must be present in the fields.conf used to configure the DataSource.
valueValue to send associated with this field name
Returns
this
virtual void Caplin.DataSource.Blotter.BlotterItem.SetFields ( IDictionary< string, string >  fieldMap)
inlinevirtual
Parameters
fieldMapMap of fields and values for this BlotterItem. The field names must be present in the fields.conf used to configure the DataSource.
Returns
this
virtual void Caplin.DataSource.Blotter.BlotterItem.SetParent ( Caplin.DataSource.Blotter.BlotterItem  parentBlotterItem)
inlinevirtual
Parameters
parentBlotterItemThe parent of this BlotterItem. To change the parent of the BlotterItem, the item must be removed and resent.
override string Caplin.DataSource.Blotter.BlotterItem.ToString ( )
inline

String containing this BlotterItem's uniqueId and fields.

Property Documentation

virtual IDictionary<string,string> Caplin.DataSource.Blotter.BlotterItem.Fields
get

A map containing all fields present on this BlotterItem.

virtual string Caplin.DataSource.Blotter.BlotterItem.UniqueId
get

uniqueId The uniqueId this BlotterItem was instantiated with.


Generated on Mon Jan 25 2016 16:33:39 for DataSource Blotter.NET