Home | Class Index

SDK Version: 3.2.1-255201

Documentation generated on 02 April 2013

    • /
        • /libs/javascript/caplin/src\caplin\element\styler\StaleStyler
          • js
        • /libs/javascript/caplin/src\caplin\grid\decorator\GroupHeaderDecorator
          • js
        • /libs/javascript/caplin/src\caplin\grid\decorator\RowLoadingDecorator
          • js
Class
caplin.sl4badapter.providers

SL4BSubscription

Extends SL4B_AbstractSubscriber.
Implements caplin.services.messaging.Subscription.
The SL4BSubscription class provides an SL4B transport implementation of the caplin.services.messaging.Subscription interface.

Constructor Summary

Attributes Name and Description
caplin.sl4badapter.providers.SL4BSubscription(String sSubject, oListener, mOptions)

Constructs an instance of caplin.sl4badapter.providers.SL4BSubscription.

Method Summary

Attributes Name and Description
void dispose()

Permanently stops the subscription from receiving new updates to the subject.
String getSubject()

Returns the subject that this subscription is subscribed to.
Boolean isPaused()

Returns whether the subscription is currently paused or not.
void pause()

Temporarily disables the subscription from receiving new updates to the subject.
void resume()

Re-enables the subscription, allowing it to receive any new updates to the subject.

Constructor Detail

► caplin.sl4badapter.providers.SL4BSubscription(String sSubject, oListener, mOptions)

Constructs an instance of caplin.sl4badapter.providers.SL4BSubscription.

Parameters
String sSubject the data subject to which to subscribe. Required; non-empty.
oListener
mOptions
Throws
caplin.core.Error
if sSubject is undefined, null or empty

Method Detail

► void dispose()

Permanently stops the subscription from receiving new updates to the subject. Should be called when there is no further need for this subscription.

Throws
caplin.core.Error
if the subscription has already been disposed of.

► String getSubject()

Returns the subject that this subscription is subscribed to.

► Boolean isPaused()

Returns whether the subscription is currently paused or not.

Throws
caplin.core.Error
if the subscription has been disposed of.

► void pause()

Temporarily disables the subscription from receiving new updates to the subject.

Throws
caplin.core.Error
if the subscription has been disposed of.

► void resume()

Re-enables the subscription, allowing it to receive any new updates to the subject.

Throws
caplin.core.Error
if the subscription has been disposed of.