public class

SubscriptionConfirmTransform

extends SubscriptionEditTransform
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.SubscriptionConfirmTransform
Known Direct Subclasses

Class Overview

This class renders the confirmation message on a successful Email, File or Print subscription.

Summary

Constants
String FP_OBJECT_INFO_STYLE Name for the formal parameter: objectInfoStyle
[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 objectInfoStyle Formal parameter: Indicate which style should be used for rendering the object information
[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
SubscriptionConfirmTransform()
Default no-argument constructor.
Public Methods
String getDescription()
Returns this transform's description.
void initializeTransform(Transformable data)
Extends initializeTransform by keeping its own copy of the data.
void renderButtonBar(MarkupOutput out)
Renders the dialogue buttons of the transform
void renderMessageFooter(MarkupOutput out)
Renders the message footer for send now actions or if the send preview option is checked.
void renderMessageTitle(MarkupOutput out)
Renders the successful message.
void renderObject(MarkupOutput out)
Renders the object information of the object to which the subscription is created.
void renderTitle(MarkupOutput out)
Renders the title informing confirmation.
void renderTriggerInfo(MarkupOutput out)
Renders the information about the trigger.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status is "Successful".
Protected Methods
WebEvent getOkEvent()
The event to trigger after the user acknowledges the success message.
String getTrigger()
Returns the trigger name corresponding of the current subscription.
WebEvent getUpdatePropertiesEvent()
[Expand]
Inherited Methods
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_OBJECT_INFO_STYLE

Name for the formal parameter: objectInfoStyle

Constant Value: "objectInfoStyle"

Fields

public FormalParameter objectInfoStyle

Formal parameter: Indicate which style should be used for rendering the object information

Public Constructors

public SubscriptionConfirmTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Returns this transform's description.

Returns
  • description for the transform

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 renderButtonBar (MarkupOutput out)

Renders the dialogue buttons of the transform

Parameters
out The transform's output.

public void renderMessageFooter (MarkupOutput out)

Renders the message footer for send now actions or if the send preview option is checked.

Parameters
out The transform's output.

public void renderMessageTitle (MarkupOutput out)

Renders the successful message.

Parameters
out The transform's output.

public void renderObject (MarkupOutput out)

Renders the object information of the object to which the subscription is created.

Parameters
out MarkupOutput instance to modify with the transform's output.

public void renderTitle (MarkupOutput out)

Renders the title informing confirmation.

Parameters
out The transform's output.

public void renderTriggerInfo (MarkupOutput out)

Renders the information about the trigger.

Parameters
out The transform's output.

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the bean status is "Successful". This transform, after collecting and saving the information, expects to go back to its previous page.

Parameters
out Output by this transform

Protected Methods

protected WebEvent getOkEvent ()

The event to trigger after the user acknowledges the success message.

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.

protected String getTrigger ()

Returns the trigger name corresponding of the current subscription.

Returns
  • the name of the trigger

protected WebEvent getUpdatePropertiesEvent ()