Package com.caplin.trading

Interface BlotterChannel

@Deprecated
public interface BlotterChannel

Deprecated.

A blotter message communication channel with a particular user.

A user may have zero or more BlotterChannels open, with different parameters. These would typically be one per differently configured blotter on the front-end.

Deprecated: Use the new Blotter API (com.caplin.datasource.blotter).

Method Summary

Modifier and Type	Method	Description
void	close()	Deprecated. Closes this BlotterChannel.
BlotterMessage	createBlotterMessage()	Deprecated. Creates a blotter message that will be sent to the user on this channel.
java.lang.String	getParameters()	Deprecated. Gets the parameters of the channel.
java.lang.String	getUserName()	Deprecated. Gets the username of the user represented by this channel
void	initialise()	Deprecated. This is an internal method.
boolean	sendBlotterItem(java.lang.String subject)	Deprecated. Sends a record update for the requested blotter item (container based blotters only).
void	sendBlotterMessage(BlotterMessage blotterMessage)	Deprecated. Sends a blotter message across this channel.

Method Detail

getUserName

java.lang.String getUserName()

Deprecated.

Gets the username of the user represented by this channel

Returns:

The username.

getParameters

java.lang.String getParameters()

Deprecated.

Gets the parameters of the channel.

Currently the parameters are the full name of the subject requested, this is liable to change to become more structured in future releases of the API.

Returns:

The parameters.

createBlotterMessage

BlotterMessage createBlotterMessage()

Deprecated.

Creates a blotter message that will be sent to the user on this channel.

Returns:

The BlotterMessage.

sendBlotterMessage

void sendBlotterMessage(BlotterMessage blotterMessage)
                 throws BlotterClosedException

Deprecated.

Sends a blotter message across this channel.

Parameters:

blotterMessage - The BlotterMessage.

Throws:

BlotterClosedException - The Blotter channel is not valid.

sendBlotterItem

boolean sendBlotterItem(java.lang.String subject)

Deprecated.

Sends a record update for the requested blotter item (container based blotters only).

Parameters:

subject - The requested Blotter record.

Returns:

true if the item was sent by this BlotterChannel

initialise

void initialise()

Deprecated.

This is an internal method.

close

void close()

Deprecated.

Closes this BlotterChannel. After this method is called, any attempt to send messages down the BlotterChannel will cause a RuntimeException to be thrown. Application code does not need to call this method, it is called internally by the TradingDataSource when the BlotterChannel is discarded by the end users' application.