com.microstrategy.web.objects.WebSubscription

Class Overview

This interface represents a Subscription to scheduled reports

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebSubscriptionAddress getAddress()
abstract String getBurstAddressAttributeId()
gets the Attribute ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.
abstract String getBurstDeviceId()
sets the Device ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.
abstract String getBurstFormId()
gets the Form ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device..
abstract ArrayList getBurstList()
abstract WebSubscriptionContent getContent()
abstract WebObjectInfo getContentForAlert()
Returns the report that has been configured to be delivered for the alert.
abstract WebSubscriptionEMMACubeOptions getEMMACubeOptions()
Returns the associate WebSubscriptionEMMACubeOptions interface which represent the EMMA cube related options for this subscription
abstract boolean getIncludePrompts()
abstract WebSubscriptionLocation getLocation()
Retrieves the WebSubscriptionLocation associated with this subscription
abstract WebSubscriptionNotification getNotification()
Retrieves the WebSubscriptionNotification object that can edited to specify whether any notification mechanism should be specified while creating the subscription.
abstract WebSubscriptionEMMACubeOptions getOrCreateEMMACubeOptions()
Returns the associate WebSubscriptionEMMACubeOptions interface which represent the EMMA cube related options for this subscription, if it was not create yet this function will create and return it
abstract WebUserEntity getOwner()
This call returns the WebUserEntity who is the owner of the subscription.
abstract String getPromptAnswerXML()
abstract WebSubscriptionRecipientList getRecipients()
Returns the WebSubscriptionRecipientList, which is a collection interface of WebSubscriptionRecipient objects who are subscribed to the current subscription.
abstract WebIServerSubscriptionTrigger getSubscriptionTrigger()
Return the WebIServerSubscriptionTrigger associated with this subscription.
abstract int getSubscriptionType()
Returns the type of the subscription, from EnumDSSXMLNCSSubscriptionType.
abstract WebSubscriptionTrigger getTrigger()
This method is deprecated. Please use getSubscriptionTrigger() instead
abstract boolean isAlertingSubscription()
Returns true if the subscription is used to define an alert
abstract boolean isInvalidSchedule()
abstract boolean isNew()
This indicates whether the whether the subscription is a new one
abstract boolean isPersonalized()
This indicates whether the content that we are creating a subscription for is prompted
abstract boolean isReuseDataSetCache()
abstract void setAddress(WebSubscriptionAddress address)
Sets the WebSubscriptionAddress to be associated with this subscription
abstract void setAlertingSubscription(boolean val)
Sets the subscription to be an alerting subscription.
abstract void setBurstAddressAttributeId(String burstAddressID)
sets the Attribute ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.
abstract void setBurstDeviceId(String burstDeviceID)
gets the Device ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.
abstract void setBurstFormId(String burstFormID)
sets the Form ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.
abstract void setBurstList(ArrayList burstList)
abstract void setContent(WebResultSetInstance instance)
Sets the content of this subscription based on an existing instance.
abstract WebSubscriptionContent setContent(WebObjectInfo woi)
sets the content for this subscription
abstract void setContentForAlert(WebObjectInfo woi)
Sets the report that needs to be delivered when an alerting condition is met.
abstract void setDeliveryMode(int deliveryMode)
Sets delivery mode.
abstract void setIncludePrompts(boolean value)
abstract void setLocation(WebSubscriptionLocation location)
Sets the WebSubscriptionLocation to be associated with this subscription A location is an abstraction that encomposses either an address or a device and is useful while creating File or Print subscriptions.
abstract void setName(String name)
Sets the name of the subscription.
abstract void setOwner(WebUserEntity owner)
Sets the owner of the subscription.
abstract void setReuseDataSetCache(boolean isReuseDataSetCache)
abstract void setTrigger(WebSubscriptionTrigger trigger)
Sets the WebSubscriptionTrigger to be associated with this subscription
[Expand]
Inherited Methods
From interface com.microstrategy.utils.StringKey
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.EditableObject
From interface com.microstrategy.web.objects.WebSubscriptionComponent
From interface com.microstrategy.web.objects.WebSubscriptionProperties

Public Methods

public abstract WebSubscriptionAddress getAddress ()

Returns

public abstract String getBurstAddressAttributeId ()

gets the Attribute ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.

public abstract String getBurstDeviceId ()

sets the Device ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.

public abstract String getBurstFormId ()

gets the Form ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device..

public abstract ArrayList getBurstList ()

public abstract WebSubscriptionContent getContent ()

Returns

public abstract WebObjectInfo getContentForAlert ()

Returns the report that has been configured to be delivered for the alert. While the condition of the alert is defined on the WebSubscriptionContent, the report that is configured to be delivered could be a different one.

public abstract WebSubscriptionEMMACubeOptions getEMMACubeOptions ()

Returns the associate WebSubscriptionEMMACubeOptions interface which represent the EMMA cube related options for this subscription

Returns

public abstract boolean getIncludePrompts ()

public abstract WebSubscriptionLocation getLocation ()

Retrieves the WebSubscriptionLocation associated with this subscription

public abstract WebSubscriptionNotification getNotification ()

Retrieves the WebSubscriptionNotification object that can edited to specify whether any notification mechanism should be specified while creating the subscription. Typically, you can create an email notification while creatin a file or print subscription

public abstract WebSubscriptionEMMACubeOptions getOrCreateEMMACubeOptions ()

Returns the associate WebSubscriptionEMMACubeOptions interface which represent the EMMA cube related options for this subscription, if it was not create yet this function will create and return it

Returns

public abstract WebUserEntity getOwner ()

This call returns the WebUserEntity who is the owner of the subscription. The owner of a subscription is the user who created the subscription

Returns
Throws
WebObjectsException
WebObjectsException

public abstract String getPromptAnswerXML ()

public abstract WebSubscriptionRecipientList getRecipients ()

Returns the WebSubscriptionRecipientList, which is a collection interface of WebSubscriptionRecipient objects who are subscribed to the current subscription.

public abstract WebIServerSubscriptionTrigger getSubscriptionTrigger ()

Return the WebIServerSubscriptionTrigger associated with this subscription.

Returns
Throws
WebObjectsException
WebObjectsException

public abstract int getSubscriptionType ()

Returns the type of the subscription, from EnumDSSXMLNCSSubscriptionType.

public abstract WebSubscriptionTrigger getTrigger ()

This method is deprecated.
Please use getSubscriptionTrigger() instead

Returns

public abstract boolean isAlertingSubscription ()

Returns true if the subscription is used to define an alert

public abstract boolean isInvalidSchedule ()

public abstract boolean isNew ()

This indicates whether the whether the subscription is a new one

Returns
  • boolean value indicating whether the subscription is new

public abstract boolean isPersonalized ()

This indicates whether the content that we are creating a subscription for is prompted

Returns
  • boolean value indicating whether the content is personalized

public abstract boolean isReuseDataSetCache ()

public abstract void setAddress (WebSubscriptionAddress address)

Sets the WebSubscriptionAddress to be associated with this subscription

public abstract void setAlertingSubscription (boolean val)

Sets the subscription to be an alerting subscription. If no content is set for alerting using setContentForAlert(WebObjectInfo), the current content getContent() will be used.

public abstract void setBurstAddressAttributeId (String burstAddressID)

sets the Attribute ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.

public abstract void setBurstDeviceId (String burstDeviceID)

gets the Device ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.

public abstract void setBurstFormId (String burstFormID)

sets the Form ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device.

public abstract void setBurstList (ArrayList burstList)

public abstract void setContent (WebResultSetInstance instance)

Sets the content of this subscription based on an existing instance. The instance can either be a WebReportInstance or a RWInstance

Throws
WebObjectsException
WebObjectsException

public abstract WebSubscriptionContent setContent (WebObjectInfo woi)

sets the content for this subscription

Parameters
woi WebObjectInfo object representing either a report or a document
Returns
Throws
WebObjectsException Thrown if the input parameter does not correspond to a valid report/document.

public abstract void setContentForAlert (WebObjectInfo woi)

Sets the report that needs to be delivered when an alerting condition is met. This could be the same report on which the alerting condition is based or a different one.

public abstract void setDeliveryMode (int deliveryMode)

Sets delivery mode.

public abstract void setIncludePrompts (boolean value)

public abstract void setLocation (WebSubscriptionLocation location)

Sets the WebSubscriptionLocation to be associated with this subscription A location is an abstraction that encomposses either an address or a device and is useful while creating File or Print subscriptions. Note that either this or the setAddress(WebSubscriptionAddress) could be used

public abstract void setName (String name)

Sets the name of the subscription.

public abstract void setOwner (WebUserEntity owner)

Sets the owner of the subscription. By default the owner of a subscription is the user whose session is used to create the subscription. However if you have the privilege to monitor and administer subscriptions, you can modify subscriptions created by other users or even create subscriptions for other users. Setting the owner as another user will essentially tie the subscription to this user.

public abstract void setReuseDataSetCache (boolean isReuseDataSetCache)

public abstract void setTrigger (WebSubscriptionTrigger trigger)

Sets the WebSubscriptionTrigger to be associated with this subscription