Home | Class Index

SDK Version: 3.1.0-24488019

Documentation generated on 03 December 2012

    • /
        • /libs/javascript/caplin/src\caplin\grid\decorator\GroupHeaderDecorator
          • js
        • /libs/javascript/caplin/src\caplin\grid\decorator\RowLoadingDecorator
          • js
Interface
caplin.core.subscriber

DataSubscriptionListener

The DataSubscriptionListener is the interface for listener objects which should be notified by a caplin.core.subscriber.DataSubscriber whenever a data update is received from the data source.

Constructor Summary

Attributes Name and Description
caplin.core.subscriber.DataSubscriptionListener()

The DataSubscriptionListener interface — this should never be constructed.

Method Summary

Attributes Name and Description
void available(String sSubject)

Gives the caplin.core.subscriber.DataSubscriptionListener the ability to be notified by a caplin.core.subscriber.DataSubscriber when data to which it has subscribed has become available.
void dataUpdated(Map mData)

Gives the caplin.core.subscriber.DataSubscriptionListener the ability to be notified by a caplin.core.subscriber.DataSubscriber when an update has been received for the data to which it has subscribed.
void unavailable(String sSubject, String sReason)

Gives the caplin.core.subscriber.DataSubscriptionListener the ability to be notified by a caplin.core.subscriber.DataSubscriber when data to which it has subscribed is no longer available.

Constructor Detail

► caplin.core.subscriber.DataSubscriptionListener()

The DataSubscriptionListener interface — this should never be constructed.

Method Detail

► void available(String sSubject)

Gives the caplin.core.subscriber.DataSubscriptionListener the ability to be notified by a caplin.core.subscriber.DataSubscriber when data to which it has subscribed has become available.

Parameters
String sSubject the subject of data which has become available on the data source.

► void dataUpdated(Map mData)

Gives the caplin.core.subscriber.DataSubscriptionListener the ability to be notified by a caplin.core.subscriber.DataSubscriber when an update has been received for the data to which it has subscribed.

Parameters
Map mData a map representing the data update.

► void unavailable(String sSubject, String sReason)

Gives the caplin.core.subscriber.DataSubscriptionListener the ability to be notified by a caplin.core.subscriber.DataSubscriber when data to which it has subscribed is no longer available.

Parameters
String sSubject the subject of data which has become unavailable on the data source.
String sReason reason for which data is no longer available from the data source.