public interface

WebSubscriptionContentReport

implements WebSubscriptionContent WebSubscriptionContentReportProperties
com.microstrategy.web.objects.WebSubscriptionContentReport

Class Overview

This interface extends WebSubscriptionContent and represents a content wrapper for a report.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.WebSubscriptionContent
Public Methods
abstract String getDeltaXML()
abstract WebReportExportSettingsImpl getExportSettings()
This needs to be used to set Mode in case of File Bursting.As without setting the mode the backend fails the subscription
abstract WebPrompts getPrompts()
Returns the prompts collection that is determined by the content that is set
abstract WebObjectInfo getTarget()
Returns the WebObjectInfo of the report that this object represents
abstract WebTemplate getTemplate()
Returns the WebTemplate for the report that the subscriptions is based on.
abstract WebWorkingSet getWorkingSet()
Returns the WebWorkingSet for the report that the subscription is based on.
abstract boolean isResolved()
Returns a boolean indicating whether all the prompts have been resolved
abstract void reprompt()
Reopens the prompts if they have already been answered.
abstract void setKeepAnswersOpen()
Sets whether we should keep the prompt answers open while creating the underlying WebReportInstance.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.StringKey
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebSubscriptionComponent
From interface com.microstrategy.web.objects.WebSubscriptionContent
From interface com.microstrategy.web.objects.WebSubscriptionContentProperties
From interface com.microstrategy.web.objects.WebSubscriptionContentReportProperties

Public Methods

public abstract String getDeltaXML ()

Throws
WebObjectsException

public abstract WebReportExportSettingsImpl getExportSettings ()

This needs to be used to set Mode in case of File Bursting.As without setting the mode the backend fails the subscription

Throws
WebObjectsException

public abstract WebPrompts getPrompts ()

Returns the prompts collection that is determined by the content that is set

Returns
Throws
WebObjectsException

public abstract WebObjectInfo getTarget ()

Returns the WebObjectInfo of the report that this object represents

Returns
Throws
WebObjectsException

public abstract WebTemplate getTemplate ()

Returns the WebTemplate for the report that the subscriptions is based on.

Returns
  • the WebTemplate for the report that the subscriptions is based on.
Throws
WebObjectsException
WebObjectsException

public abstract WebWorkingSet getWorkingSet ()

Returns the WebWorkingSet for the report that the subscription is based on.

Returns
  • the WebWorkingSet for the report that the subscription is based on.
Throws
WebObjectsException
WebObjectsException

public abstract boolean isResolved ()

Returns a boolean indicating whether all the prompts have been resolved

Returns
  • boolean
Throws
WebObjectsException

public abstract void reprompt ()

Reopens the prompts if they have already been answered. The underlying report instance needs to be in a result status for this to take effect. If the status is not result, then a WebObjectsException is thrown

Throws
WebObjectsException thrown if the underlying report instance is not in a ready status or if there is any other error while trying to reload the prompts

public abstract void setKeepAnswersOpen ()

Sets whether we should keep the prompt answers open while creating the underlying WebReportInstance. By default, we will close the answers. Note that this flag will only take effect if the underlying WebReportInstance has not yet been created.

Throws
WebObjectsException
WebObjectsException