WebSubscriptionContent
implements WebSubscriptionComponent WebSubscriptionContentProperties| com.microstrategy.web.objects.WebSubscriptionContent |
 Known Indirect Subclasses
|
Class Overview
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).
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | VIEW_MODE_GRAPH | Constant value indicating that the view is Graph | |||||||||
| String | VIEW_MODE_GRID | Constant value indicating that the view is Grid | |||||||||
| String | VIEW_MODE_GRID_GRAPH | Constant value indicating that the view is Grid and Graph | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.serialization.EnumWebPersistableState
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract SimpleList | getAddresses() | ||||||||||
| abstract SimpleList | getAvailableFormats() | ||||||||||
| abstract int |
getContentType()
Indicates the type of content.
| ||||||||||
| abstract SimpleList | getLocations() | ||||||||||
| abstract WebObjectInfo | getTarget() | ||||||||||
| abstract boolean |
getTriggerNonSchedulable()
return whether the trigger is nonSchedulable.
| ||||||||||
| abstract SimpleList | getTriggers() | ||||||||||
| abstract boolean |
hasPageBy()
Returns if the content has a page by (in the case of reports) or a group by
(in the case of documents)
| ||||||||||
| abstract 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.
| ||||||||||
| abstract boolean | isPersonalized() | ||||||||||
| abstract void |
removeMessage()
Remove the message if there's any.
| ||||||||||
|
[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.WebSubscriptionContentProperties
| |||||||||||
Constants
public static final String VIEW_MODE_GRAPH
Constant value indicating that the view is Graph
public static final String VIEW_MODE_GRID
Constant value indicating that the view is Grid
public static final String VIEW_MODE_GRID_GRAPH
Constant value indicating that the view is Grid and Graph
Public Methods
public abstract SimpleList getAddresses ()
Returns
SimpleListof user addresses relevant for this content (report/document).
Throws
| WebObjectsException | Thrown if there is an error reading the list of addresses from the metadata |
|---|
public abstract SimpleList getAvailableFormats ()
Returns
- list of
WebSubscriptionContentFormatobjects
Throws
| WebObjectsException | if there is an error retrieving the list of format objects |
|---|
public abstract int getContentType ()
Indicates the type of content.
This is a value from EnumWebSubscriptionContentTypes
Returns
- the type of content as defined in
EnumWebSubscriptionContentTypes
public abstract SimpleList getLocations ()
public abstract boolean getTriggerNonSchedulable ()
return whether the trigger is nonSchedulable.
Throws
| WebObjectsException |
|---|
public abstract SimpleList getTriggers ()
Returns
SimpleListof triggers relevant for this content (report/document).
Throws
| WebObjectsException | Thrown if there is an error reading the list of triggers from the metadata |
|---|
public abstract boolean hasPageBy ()
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 | |
| WebObjectsException |
public abstract 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
public abstract boolean isPersonalized ()
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 |
|---|