public interface

WebIServerSubscriptionTrigger

implements WebObjectInfo WebSubscriptionTrigger
com.microstrategy.web.objects.WebIServerSubscriptionTrigger

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract SimpleList getSubscriptions(WebSubscriptionsFilter filter, int blockBegin, int blockCount)
Returns a SimpleList collection of WebSubscription objects which use this particular trigger, from a specified begin block, up to a specified block count.
abstract SimpleList getSubscriptions(int deliveryMode)
Returns a SimpleList collection of WebSubscription objects which use this trigger/schedule for a specified deliveryMode.
abstract SimpleList getSubscriptions(int deliveryMode, int blockBegin, int blockCount)
Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, for a specified delivery mode, from a specified begin block, up to a specified block count.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.StringKey
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite
From interface com.microstrategy.web.objects.WebSubscriptionComponent
From interface com.microstrategy.web.objects.WebSubscriptionTrigger

Public Methods

public abstract SimpleList getSubscriptions (WebSubscriptionsFilter filter, int blockBegin, int blockCount)

Returns a SimpleList collection of WebSubscription objects which use this particular trigger, from a specified begin block, up to a specified block count. The results are filtered by the specified filter

Parameters
filter WebSubscriptionsFilter used to filter results. A blank filter can be retrieved from getNewSubscriptionsFilter()
blockBegin , the starting count of subscription, it is 0-based index which means set it N will return subscriptions from the (N+1)th subscription.
blockCount , block size for the incremental fetch of subscription. If set it 0, will return all subscriptions from the starting count
Returns
Throws
WebObjectsException
WebObjectsException

public abstract SimpleList getSubscriptions (int deliveryMode)

Returns a SimpleList collection of WebSubscription objects which use this trigger/schedule for a specified deliveryMode.

Parameters
deliveryMode , from EnumDSSXMLSubscriptionDeliveryType

public abstract SimpleList getSubscriptions (int deliveryMode, int blockBegin, int blockCount)

Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, for a specified delivery mode, from a specified begin block, up to a specified block count.

Parameters
deliveryMode , from EnumDSSXMLSubscriptionDeliveryType
blockBegin , the starting count of subscription, it is 0-based index which means set it N will return subscriptions from the (N+1)th subscription.
blockCount , block size for the incremental fetch of subscription. If set it 0, will return all subscriptions from the starting count