public class

SubscriptionEditPrintTransform

extends SubscriptionEditFileTransform
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
             ↳ com.microstrategy.web.app.transforms.SubscriptionEditFileTransform
               ↳ com.microstrategy.web.app.transforms.SubscriptionEditPrintTransform

Class Overview

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

Summary

Constants
String FP_SHOW_COLLATE_OPTION Name for the Formal Parameter FP_SHOW_COLLATE_OPTION
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.SubscriptionEditTransform
From class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter showCollateOption Indicates if we need to show the collate option for print properties.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.SubscriptionEditTransform
From class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SubscriptionEditPrintTransform()
The default constructor.
Public Methods
WebEvent getAddEvent()
The event to create a new subscription.
String getDescription()
Returns the description of this transform.
SubscriptionPrintWidget getSubscriptionPrintWidget()
The SubscriptionPrint widget used to render the subscription pane.
void transformForRequestInError(MarkupOutput out)
Transform when the status is In Error.
Protected Methods
WebEvent getUpdatePropertiesEvent()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.SubscriptionEditFileTransform
From class com.microstrategy.web.app.transforms.SubscriptionEditTransform
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_SHOW_COLLATE_OPTION

Name for the Formal Parameter FP_SHOW_COLLATE_OPTION

Constant Value: "showCollateOption"

Fields

public FormalParameter showCollateOption

Indicates if we need to show the collate option for print properties.

Public Constructors

public SubscriptionEditPrintTransform ()

The default constructor. Initializes the formal parameters.

Public Methods

public WebEvent getAddEvent ()

The event to create a new subscription.

Returns
  • The EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE_FILE event

public String getDescription ()

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

Returns
  • The description of this transform.

public SubscriptionPrintWidget getSubscriptionPrintWidget ()

The SubscriptionPrint widget used to render the subscription pane.

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

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 getUpdatePropertiesEvent ()