Package com.microstrategy.web.objects

Interface WebSubscriptionContentReport

All Superinterfaces:

EnumWebPersistableState, Persistable, StringKey, WebSubscriptionComponent, WebSubscriptionContent, WebSubscriptionContentProperties, WebSubscriptionContentReportProperties

public interface WebSubscriptionContentReport
extends WebSubscriptionContent, WebSubscriptionContentReportProperties

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

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Fields inherited from interface com.microstrategy.web.objects.WebSubscriptionContent

VIEW_MODE_GRAPH, VIEW_MODE_GRID, VIEW_MODE_GRID_GRAPH

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDeltaXML()
com.microstrategy.web.objects.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
WebPrompts	getPrompts()	Returns the prompts collection that is determined by the content that is set
WebObjectInfo	getTarget()	Returns the WebObjectInfo of the report that this object represents
WebTemplate	getTemplate()	Returns the WebTemplate for the report that the subscriptions is based on.
WebWorkingSet	getWorkingSet()	Returns the WebWorkingSet for the report that the subscription is based on.
boolean	isResolved()	Returns a boolean indicating whether all the prompts have been resolved
void	reprompt()	Reopens the prompts if they have already been answered.
void	setKeepAnswersOpen()	Sets whether we should keep the prompt answers open while creating the underlying WebReportInstance.

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.utils.StringKey

getStringKey

Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionComponent

getDescription, getID, getName, getSessionInfo, getType, isPopulated, populate

Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionContent

getAddresses, getAvailableFormats, getContentType, getLocations, getTriggerNonSchedulable, getTriggers, hasPageBy, isAlertContentDifferentFromSubscriptionContent, isPersonalized, removeMessage

Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionContentProperties

getFormat, getFormatMode, isFormatCompressed, setCompressed, setFormat, setFormatMode

Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionContentReportProperties

getViewMode, setViewMode

Method Detail

getPrompts

WebPrompts getPrompts()
               throws WebObjectsException

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

Returns:

WebPrompts collection for the content set

Throws:

WebObjectsException

reprompt

void reprompt()
       throws WebObjectsException

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

Since:

MicroStrategy Web 8.0.0

isResolved

boolean isResolved()
            throws WebObjectsException

Returns a boolean indicating whether all the prompts have been resolved

Returns:

boolean

Throws:

WebObjectsException

getTarget

WebObjectInfo getTarget()
                 throws WebObjectsException

Returns the WebObjectInfo of the report that this object represents

Specified by:

getTarget in interface WebSubscriptionContent

Returns:

the WebObjectInfo of the report that this object represents

Throws:

WebObjectsException

getTemplate

WebTemplate getTemplate()
                 throws WebObjectsException

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

Since:

MicroStrategy Web 9.0.0

getWorkingSet

WebWorkingSet getWorkingSet()
                     throws WebObjectsException

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

Since:

MicroStrategy Web 9.0.0

setKeepAnswersOpen

void setKeepAnswersOpen()
                 throws WebObjectsException

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

Since:

MicroStrategy Web 9.0.0

getDeltaXML

java.lang.String getDeltaXML()
                      throws WebObjectsException

Throws:

WebObjectsException

getExportSettings

com.microstrategy.web.objects.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

Since:

MicroStrategy Web 9.4.1 Hotfix