public interface

WebSubscriptionContentDocument

implements WebSubscriptionContent
com.microstrategy.web.objects.WebSubscriptionContentDocument

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.WebSubscriptionContent
Public Methods
abstract RWExportSettingsImpl 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 document that this object represents
abstract boolean isMultiLayout()
Returns true if the document has multiple layouts.
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 RWInstance or WebDocumentInstance By default, we will close the answers.
[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

Public Methods

public abstract RWExportSettingsImpl 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

public abstract WebObjectInfo getTarget ()

Returns the WebObjectInfo of the document that this object represents

Returns

public abstract boolean isMultiLayout ()

Returns true if the document has multiple layouts. Otherwise returns false

Throws
WebObjectsException
WebObjectsException

public abstract boolean isResolved ()

Returns a boolean indicating whether all the prompts have been resolved

Returns
  • boolean

public abstract void reprompt ()

Reopens the prompts if they have already been answered. The underlying document 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 document 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 RWInstance or WebDocumentInstance By default, we will close the answers. Note that this flag will only take effect if the underlying RWInstance or WebDocumentInstance has not yet been created.

Throws
WebObjectsException
WebObjectsException