B C G I O R S T
All Classes All Packages

B

BlotterApplicationListener - Interface in com.caplin.datasource.blotter

Blotter Application Listener for callbacks when requests and discards for blotter channels are received: BlotterApplicationListener.blotterChannelOpened(com.caplin.datasource.blotter.BlotterChannel) and BlotterApplicationListener.blotterChannelClosed(com.caplin.datasource.blotter.BlotterChannel).

BlotterChannel - Interface in com.caplin.datasource.blotter

BlotterChannel is the entry point for sending out BlotterItems.

blotterChannelClosed(BlotterChannel) - Method in interface com.caplin.datasource.blotter.BlotterApplicationListener

Callback invoked when a discard for a blotter is received.

BlotterChannelListener - Interface in com.caplin.datasource.blotter

Specifically for the case where there is more than one Integration Adapter providing for the same channel subject.

blotterChannelOpened(BlotterChannel) - Method in interface com.caplin.datasource.blotter.BlotterApplicationListener

Callback invoked when a request for a blotter is received.

BlotterConfiguration - Class in com.caplin.datasource.blotter

Configuration for the Blotter Provider.

BlotterConfiguration(String, String, String) - Constructor for class com.caplin.datasource.blotter.BlotterConfiguration

Instantiates a new Blotter configuration.

BlotterConfiguration(String, String, String, String) - Constructor for class com.caplin.datasource.blotter.BlotterConfiguration

Instantiates a new Blotter configuration.

BlotterItem - Class in com.caplin.datasource.blotter

BlotterItem is the data type representing a single item on the blotter.

BlotterItem(String) - Constructor for class com.caplin.datasource.blotter.BlotterItem

BlotterProvider - Class in com.caplin.datasource.blotter

This is the entry point into the Blotter API.

BlotterProvider(DataSource, BlotterConfiguration, BlotterApplicationListener) - Constructor for class com.caplin.datasource.blotter.BlotterProvider

Create a BlotterProvider registering your application.

C

clear() - Method in interface com.caplin.datasource.blotter.BlotterChannel

Clears all BlotterItems from the internal cache and sends a container clear so that these items are no longer requested when the channel is subscribed to.

closeChannel() - Method in interface com.caplin.datasource.blotter.BlotterChannel

Closes the channel.

com.caplin.datasource.blotter - package com.caplin.datasource.blotter

This package contains the public elements of the BlotterAPI.

G

getBlotterIdentifier() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Gets the blotter identifier name.

getChannelNamespace() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Gets the channel namespace.

getContainerConfiguration() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

getContainerThrottleMillis() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Get the current millisecond delay used for container throttling

getField(String) - Method in class com.caplin.datasource.blotter.BlotterItem

getFields() - Method in class com.caplin.datasource.blotter.BlotterItem

getHexEncodedUniqueId() - Method in class com.caplin.datasource.blotter.BlotterItem

getItemNamespace() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Gets the item namespace.

getParameters() - Method in interface com.caplin.datasource.blotter.BlotterChannel

Returns the parameters for the channel

getParent() - Method in class com.caplin.datasource.blotter.BlotterItem

getSubContainerMaxDepth() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Gets the max depth of the sub containers.

getSubContainerNamespace() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Gets the sub channel namespace.

getSubject() - Method in interface com.caplin.datasource.blotter.BlotterChannel

Returns the subject for the channel.

getUniqueId() - Method in class com.caplin.datasource.blotter.BlotterItem

getUsername() - Method in interface com.caplin.datasource.blotter.BlotterChannel

Returns the username for the channel

getVersion() - Method in class com.caplin.datasource.blotter.BlotterProvider

Get the Blotter API version.

I

isAutoPermit() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Gets whether automatically permitted.

isAutoSendEmptyContainer() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Gets whether an empty container should be sent automatically as a response to a request

isChannelUsingImageFlag() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Returns true if image flags are used in the channel for its initial message, or false otherwise.

isItemUsingImageFlag() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Returns true if image flags are used on each channel item for their initial messages, or false otherwise.

isMoveItemToTopWhenModified() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Gets whether items should be moved to the top of the container upon modification

isPrefixIdWithIdentifier() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

When true then the ID will be prefixed with the blotterIdentifier followed by a dash.

isUseGenericObjects() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Gets whether generic objects should be used instead of Type1 Records

O

onBlotterItemRequest(BlotterChannel, String) - Method in interface com.caplin.datasource.blotter.BlotterChannelListener

Called when a previously unsubmitted item in a blotter channel is requested.

R

removeBlotterItem(String) - Method in interface com.caplin.datasource.blotter.BlotterChannel

Removes the BlotterItem from the internal cache and sends a container remove so that this item is no longer requested when the channel is subscribed to.

removeBlotterItems(List<String>) - Method in interface com.caplin.datasource.blotter.BlotterChannel

Removes BlotterItems from the internal cache and sends a container remove so that these items are no longer requested when the channel is subscribed to.

S

sendBlotterItem(BlotterItem) - Method in interface com.caplin.datasource.blotter.BlotterChannel

Adds the BlotterItem to the internal cache and sends a container add so that this item is requested when the channel is subscribed to.

sendBlotterItemNotFound(String) - Method in interface com.caplin.datasource.blotter.BlotterChannel

Sends a not found for a BlotterItem.

sendBlotterItems(List<BlotterItem>) - Method in interface com.caplin.datasource.blotter.BlotterChannel

Adds BlotterItems to the internal cache and sends a container add so that these items are requested when the channel is subscribed to.

sendBlotterItemStatusOk(String) - Method in interface com.caplin.datasource.blotter.BlotterChannel

Send status ok for a BlotterItem.

sendBlotterItemStatusStale(String) - Method in interface com.caplin.datasource.blotter.BlotterChannel

Send status stale for a BlotterItem.

sendBlotterStatusOk() - Method in interface com.caplin.datasource.blotter.BlotterChannel

Sends a status ok on the channel.

sendBlotterStatusStale() - Method in interface com.caplin.datasource.blotter.BlotterChannel

Sends a status stale on the channel.

sendEmptyBlotter() - Method in interface com.caplin.datasource.blotter.BlotterChannel

Sends an empty container on the channel.

setAutoPermit(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Sets auto permit enabled/disabled.

setAutoSendEmptyContainer() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Sets whether an empty container should automatically be sent or not when the channel opens

setBlotterChannelListener(BlotterChannelListener) - Method in interface com.caplin.datasource.blotter.BlotterChannel

Sets a BlotterChannelListener on the channel.

setChannelUsingImageFlag(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Set to true and the channel container will use an image flag when sending the initial message

setContainerThrottleMillis(int) - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Specify the millisecond delay used to throttle subsequent operations to a single container.

setField(String, String) - Method in class com.caplin.datasource.blotter.BlotterItem

setFields(Map<String, String>) - Method in class com.caplin.datasource.blotter.BlotterItem

setItemUsingImageFlag(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Set to true and the channel items will use image flags when sending their initial messages

setMoveItemToTopWhenModified(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Sets whether to move an existing item to the top of the container when sendBlotterItem with an Item with the same ID gets called again

setParent(BlotterItem) - Method in class com.caplin.datasource.blotter.BlotterItem

Deprecated.

use BlotterItem.setParentItem(com.caplin.datasource.blotter.BlotterItem)

setParentItem(BlotterItem) - Method in class com.caplin.datasource.blotter.BlotterItem

setPrefixIdWithIdentifier(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Set to false to turn off prefixing of ID's with the blotterIdentifier followed by a -.

setSubcontainerMaxDepth(int) - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Sets the subcontainer maximum depth.

setUseGenericObjects(boolean) - Method in class com.caplin.datasource.blotter.BlotterConfiguration

Set whether the API should use generic objects instead of Type1 records.

T

toRecordItem(BlotterConfiguration, String, String) - Method in class com.caplin.datasource.blotter.BlotterItem

toString() - Method in class com.caplin.datasource.blotter.BlotterConfiguration

toString() - Method in class com.caplin.datasource.blotter.BlotterItem

B C G I O R S T
All Classes All Packages