public class

SubscriptionEditTransform

extends AbstractSubscriptionEditTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
           ↳ com.microstrategy.web.app.transforms.SubscriptionEditTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This class renders the output to create/edit an email subscription. It supports creating email subscriptions for prompted and non-prompted reports. It uses a SubscriptionBean for this.

Summary

Nested Classes
interface SubscriptionEditTransform.NCSRecipientContext  
class SubscriptionEditTransform.RecipientContext  
Constants
String FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH Name for the formal parameter FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected WebEvent _addEvent The event for the creating the subscription
protected boolean _allowSubscription
protected WebEvent _cancelEvent The event for the canceling the current action
protected boolean _isUserAllowedToSubscribe
protected WebEvent _personalizationLinkEvent
protected WebEvent _returnEvent The event for the returning to the previous state
protected String _subscribeGraphAsGridGraph The boolean value to indicate if graphs are to be subscribed as grid-graph.
protected SubscriptionBean _subscriptionBean
protected WebEvent _updatePropertiesEvent
public FormalParameter subscribeGraphAsGridGraph Indicates if graphs are to be subscribed as grid-graph.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SubscriptionEditTransform()
Default no argument constructor, initialize formal parameters.
Public Methods
WebEvent getAddEvent()
The event to create a new subscription.
WebEvent getAddressEvent()
The event to go to the address page.
SimpleList getAvailableTriggers()
Return the list of available triggers for subscription.
WebEvent getCancelEvent()
The event to cancel the subscription.
WebSubscriptionContentFormat getCurrentFormat()
Returns the current format for this subscription used when creating the subscription.
String getDescription()
Returns the description of this transform.
PromptsBean getPromptsBean()
Return the PromptsBean associated with the SubscriptionBean.
WebEvent getReturnEvent()
The event to trigger after the subscription is saved correctly.
SubscriptionWidget getSubscriptionWidget()
The subscription widget used to render the subscription pane.
Class getSupportedBeanType()
Returns the supported bean type for the transform.
int getViewMode()
The subscription view mode.
void initializeTransform(Transformable data)
Extends initializeTransform by keeping its own copy of the data.
void renderJobExpiredSection(MarkupOutput out)
Renders the job expired section, including an error message and an reexecute button
void renderSchedulePane(MarkupOutput out)
Renders the schedule pane for the user to subscribe to a report or document.
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

boolean supports(Class type)
Overrrides supports by only supporting SubscriptionBean.
void transformForRequestInError(MarkupOutput out)
Transform when the status is In Error.
Protected Methods
WebEvent getPersonalizationLinkEvent()
SubscriptionBean getSubscriptionBean()
Return the the SubscriptionBean that this transform is going to transform.
WebEvent getUpdatePropertiesEvent()
void initWidget(DefaultSubscriptionWidget widget, WebEvent addEvent)
void setExpandLayoutProperties(DefaultSubscriptionWidget widget, WebEvent addEvent)
void setExpandPageByProperties(DefaultSubscriptionWidget widget, WebEvent addEvent)
setExpandPageByProperties
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH

Name for the formal parameter FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH

Constant Value: "subscribeGraphAsGridGraph"

Fields

protected WebEvent _addEvent

The event for the creating the subscription

protected boolean _allowSubscription

protected WebEvent _cancelEvent

The event for the canceling the current action

protected boolean _isUserAllowedToSubscribe

protected WebEvent _personalizationLinkEvent

protected WebEvent _returnEvent

The event for the returning to the previous state

protected String _subscribeGraphAsGridGraph

The boolean value to indicate if graphs are to be subscribed as grid-graph.

protected SubscriptionBean _subscriptionBean

protected WebEvent _updatePropertiesEvent

public FormalParameter subscribeGraphAsGridGraph

Indicates if graphs are to be subscribed as grid-graph. If we are subscribing to a graph and this proerty is set to true, then we will create a subscription for a grid-grah rather than a graph. This property is usually mapped to a graph preference which indicates if we want to run all graphs as grid-graphs.
If this formal parameter is set to "1", it will be treated as true.

Public Constructors

public SubscriptionEditTransform ()

Default no argument constructor, initialize formal parameters.

Public Methods

public WebEvent getAddEvent ()

The event to create a new subscription.

Returns
  • The EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE event

public WebEvent getAddressEvent ()

The event to go to the address page.

Returns
  • The EnumServletEvents.WebEventNCAddresses event

public SimpleList getAvailableTriggers ()

Return the list of available triggers for subscription.

Returns
  • The list of Available triggers.

public WebEvent getCancelEvent ()

The event to cancel the subscription.

Returns
  • The EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_CANCEL event.

public WebSubscriptionContentFormat getCurrentFormat ()

Returns the current format for this subscription used when creating the subscription. This could be HTML or EXCEL or PDF or any other such format.

Returns
  • The current subscription format.

public String getDescription ()

Returns the description of this transform. This is used in the style catalog editor.

Returns
  • The description of this transform.

public PromptsBean getPromptsBean ()

Return the PromptsBean associated with the SubscriptionBean.

Returns

public WebEvent getReturnEvent ()

The event to trigger after the subscription is saved correctly.

Returns
  • By default, the EnumServletEvents.WebEventCancel event, however if coming from the SaveAs page, it returns the EnumServletEvents.WebEventOpenObjectSubscriptions, to go to the list of subscriptions.

public SubscriptionWidget getSubscriptionWidget ()

The subscription widget used to render the subscription pane.

Returns
  • A com.microstrategy.web.app.transforms.SubscriptionWidget instance.

public Class getSupportedBeanType ()

Returns the supported bean type for the transform.

Returns

public int getViewMode ()

The subscription view mode. Possible values are VIEW_MODE_GRID, VIEW_MODE_GRAPH, VIEW_MODE_GRID_GRAPH or VIEW_MODE_DOCUMENT.

Returns
  • The view mode of the subscription.

public void initializeTransform (Transformable data)

Extends initializeTransform by keeping its own copy of the data. This method initializes the private and protected fields of the transform. It also invokes the initializeTransform method of the parent.

Parameters
data the bean to transform.

public void renderJobExpiredSection (MarkupOutput out)

Renders the job expired section, including an error message and an reexecute button

Parameters
out Output by this transform

public void renderSchedulePane (MarkupOutput out)

Renders the schedule pane for the user to subscribe to a report or document. It uses an instance of the com.microstrategy.web.app.transforms.SubscriptionWidget for this purpose.

Parameters
out Output by this transform.

public void renderShell (MarkupOutput out)

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Parameters
out output by this transform

public boolean supports (Class type)

Overrrides supports by only supporting SubscriptionBean.

Parameters
type The bean type.
Returns
  • true if bean is assignable to a SubscriptionBean.

public void transformForRequestInError (MarkupOutput out)

Transform when the status is In Error. Overwrites transformForRequestInError by showing a "The email subscription feature is currently unavailable" message.

Parameters
out Output by this transform

Protected Methods

protected WebEvent getPersonalizationLinkEvent ()

protected SubscriptionBean getSubscriptionBean ()

Return the the SubscriptionBean that this transform is going to transform.

Returns

protected WebEvent getUpdatePropertiesEvent ()

protected void initWidget (DefaultSubscriptionWidget widget, WebEvent addEvent)

protected void setExpandLayoutProperties (DefaultSubscriptionWidget widget, WebEvent addEvent)

protected void setExpandPageByProperties (DefaultSubscriptionWidget widget, WebEvent addEvent)

setExpandPageByProperties

Parameters
widget SubscriptionWidget
addEvent WebEvent