Package com.microstrategy.web.objects

Interface WebSubscriptionContent

All Superinterfaces:

EnumWebPersistableState, Persistable, StringKey, WebSubscriptionComponent, WebSubscriptionContentProperties

All Known Subinterfaces:

WebSubscriptionContentDocument, WebSubscriptionContentReport

public interface WebSubscriptionContent
extends WebSubscriptionContentProperties, WebSubscriptionComponent

This object encapsulates the report/document that the user subscribes to. It has methods to retrieve the addresses and triggers that are relevant to that particular report/document. This object can also be used to read/change the personalization (prompt answers).

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	VIEW_MODE_GRAPH	Constant value indicating that the view is Graph
static java.lang.String	VIEW_MODE_GRID	Constant value indicating that the view is Grid
static java.lang.String	VIEW_MODE_GRID_GRAPH	Constant value indicating that the view is Grid and Graph

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

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
SimpleList	getAddresses()
SimpleList	getAvailableFormats()
int	getContentType()	Indicates the type of content.
SimpleList	getLocations()
WebObjectInfo	getTarget()
boolean	getTriggerNonSchedulable()	return whether the trigger is nonSchedulable.
SimpleList	getTriggers()
boolean	hasPageBy()	Returns if the content has a page by (in the case of reports) or a group by (in the case of documents)
boolean	isAlertContentDifferentFromSubscriptionContent()	Returns if the content that is delivered in an alert subscription is different from the content on which the alert is based on.
boolean	isPersonalized()
void	removeMessage()	Remove the message if there's any.

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.WebSubscriptionContentProperties

getFormat, getFormatMode, isFormatCompressed, setCompressed, setFormat, setFormatMode

Field Detail

VIEW_MODE_GRID

static final java.lang.String VIEW_MODE_GRID

Constant value indicating that the view is Grid

See Also:

Constant Field Values

VIEW_MODE_GRAPH

static final java.lang.String VIEW_MODE_GRAPH

Constant value indicating that the view is Graph

See Also:

Constant Field Values

VIEW_MODE_GRID_GRAPH

static final java.lang.String VIEW_MODE_GRID_GRAPH

Constant value indicating that the view is Grid and Graph

See Also:

Constant Field Values

Method Detail

getAvailableFormats

SimpleList getAvailableFormats()
                        throws WebObjectsException

Returns:

list of WebSubscriptionContentFormat objects

Throws:

WebObjectsException - if there is an error retrieving the list of format objects

getTriggers

SimpleList getTriggers()
                throws WebObjectsException

Returns:

SimpleList of triggers relevant for this content (report/document).

Throws:

WebObjectsException - Thrown if there is an error reading the list of triggers from the metadata

getTriggerNonSchedulable

boolean getTriggerNonSchedulable()
                          throws WebObjectsException

return whether the trigger is nonSchedulable.

Throws:

WebObjectsException

getAddresses

SimpleList getAddresses()
                 throws WebObjectsException

Returns:

SimpleList of user addresses relevant for this content (report/document).

Throws:

WebObjectsException - Thrown if there is an error reading the list of addresses from the metadata

getContentType

int getContentType()

Description copied from interface: WebSubscriptionContentProperties

Indicates the type of content. This is a value from EnumWebSubscriptionContentTypes

Specified by:

getContentType in interface WebSubscriptionContentProperties

Returns:

the type of content as defined in EnumWebSubscriptionContentTypes

isPersonalized

boolean isPersonalized()
                throws WebObjectsException

Returns:

boolean value indicating whether the report/document associated with this content object has prompts to be answered

Throws:

WebObjectsException - Thrown if there is an error reading information about the prompts collection

getLocations

SimpleList getLocations()
                 throws WebObjectsException

Returns:

the available locations

Throws:

WebObjectsException

Since:

MicroStrategy Web 7.5.1

hasPageBy

boolean hasPageBy()
           throws WebObjectsException

Returns if the content has a page by (in the case of reports) or a group by (in the case of documents)

Returns:

boolean indicating if the content has a page by or group by

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.0

isAlertContentDifferentFromSubscriptionContent

boolean isAlertContentDifferentFromSubscriptionContent()

Returns if the content that is delivered in an alert subscription is different from the content on which the alert is based on. This is the case when the alerting condition is created on report R1, but the subscription is set up to send a different report or document

Since:

MicroStrategy Web 9.0.0

removeMessage

void removeMessage()
            throws WebObjectsException

Remove the message if there's any.

Throws:

WebObjectsException

getTarget

WebObjectInfo getTarget()
                 throws WebObjectsException

Throws:

WebObjectsException