public class

ScheduleOverwriteTransform

extends AbstractAppTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.ScheduleOverwriteTransform

This class is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. There is no use-case to display an 'overwrite' message for subscriptions because we now support multiple subscriptions to the same object with same/different personalization

Class Overview

Renders a confirmation message when a WebSchedule is about to be overwritten.

Summary

Constants
String FP_IMG_DATAMART This constant is deprecated. the formal parameter associated with this constant has been deprecated.
String FP_IMG_DOCUMENT This constant is deprecated. the formal parameter associated with this constant has been deprecated.
String FP_IMG_GRAPH This constant is deprecated. the formal parameter associated with this constant has been deprecated.
String FP_IMG_GRID This constant is deprecated. the formal parameter associated with this constant has been deprecated.
String FP_IMG_GRID_GRAPH This constant is deprecated. the formal parameter associated with this constant has been deprecated.
String FP_IMG_RW_DOCUMENT This constant is deprecated. the formal parameter associated with this constant has been deprecated.
String FP_OBJECT_INFO_STYLE Name for the formal parameter: objectInfoStyle
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public final int VIEW_MODE_DOCUMENT
public final int VIEW_MODE_GRAPH
public final int VIEW_MODE_GRID
public final int VIEW_MODE_GRID_GRAPH
public FormalParameter datamartImage This field is deprecated. The image is now defined by css class name
public FormalParameter documentImage This field is deprecated. The image is now defined by css class name
public FormalParameter graphImage This field is deprecated. The image is now defined by css class name
public FormalParameter gridGraphImage This field is deprecated. The image is now defined by css class name
public FormalParameter gridImage This field is deprecated. The image is now defined by css class name
public FormalParameter objectInfoStyle Formal parameter: Indicate which style should be used for rendering the object information
public FormalParameter rwDocumentImage This field is deprecated. The image is now defined by css class name
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ScheduleOverwriteTransform()
Default no argumnet constructor, initialize formal parameters.
Public Methods
WebEvent getCancelEvent()
The event to cancel the subscription.
String getDescription()
Returns the description of this transform.
WebEvent getReturnEvent()
The event to trigger after the schedule is saved correctly.
WebEvent getSaveEvent()
The event to create a new subscription.
Class getSupportedBeanType()
Returns the supported bean type for the transform.
void initializeTransform(Transformable data)
Extends initializeTransform by keeping its own copy of the data.
void renderAreYouSure(MarkupOutput out)
void renderDuplicateMessage(MarkupOutput out)
void renderExecuteButtons(MarkupOutput out)
Renders the "Overwrite" and "Cancel" buttons on the overwrite dialog.
void renderFormEnd(MarkupOutput out)
Renders the FORM tag end.
void renderFormStart(MarkupOutput out)
Renders the FORM tag start.
void renderMessageFooter(MarkupOutput out)
void renderMessageTitle(MarkupOutput out)
void renderMobileMessage(MarkupOutput out)
void renderObjectInfo(MarkupOutput out)
Renders the object information of the object to which the subscription is created.
void renderTitle(MarkupOutput out)
Renders the title informing about overwriting the web schedule.
void renderTriggerInfo(MarkupOutput out)
Renders the information about the trigger about to be overwritten.
void renderTriggerInfo(MarkupOutput out, WebSchedule ws)
void transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status is "Successful".
void transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the bean status is "WaitingForUserInput".
[Expand]
Inherited Methods
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_IMG_DATAMART

This constant is deprecated.
the formal parameter associated with this constant has been deprecated.

Constant Value: "datamartImage"

public static final String FP_IMG_DOCUMENT

This constant is deprecated.
the formal parameter associated with this constant has been deprecated.

Constant Value: "documentImage"

public static final String FP_IMG_GRAPH

This constant is deprecated.
the formal parameter associated with this constant has been deprecated.

Constant Value: "graphImage"

public static final String FP_IMG_GRID

This constant is deprecated.
the formal parameter associated with this constant has been deprecated.

Constant Value: "gridImage"

public static final String FP_IMG_GRID_GRAPH

This constant is deprecated.
the formal parameter associated with this constant has been deprecated.

Constant Value: "gridGraphImage"

public static final String FP_IMG_RW_DOCUMENT

This constant is deprecated.
the formal parameter associated with this constant has been deprecated.

Constant Value: "rwDocumentImage"

public static final String FP_OBJECT_INFO_STYLE

Name for the formal parameter: objectInfoStyle

Constant Value: "objectInfoStyle"

Fields

public final int VIEW_MODE_DOCUMENT

Constant Value: 3 (0x00000003)

public final int VIEW_MODE_GRAPH

Constant Value: 1 (0x00000001)

public final int VIEW_MODE_GRID

Constant Value: 0 (0x00000000)

public final int VIEW_MODE_GRID_GRAPH

Constant Value: 2 (0x00000002)

public FormalParameter datamartImage

This field is deprecated.
The image is now defined by css class name

Name of the image used to display when overwriting a datamart report subscription. If you have a subscription to a grid report and if you try to create a new subscription to the same report with the same schedule, then we will show you an overwrite confirm message along with this image.

public FormalParameter documentImage

This field is deprecated.
The image is now defined by css class name

Name of the image used to display when overwriting a document subscription. If you have a subscription to a document and if you try to create a new subscription to the same document with the same schedule, then we will show you an overwrite confirm message along with this image.

public FormalParameter graphImage

This field is deprecated.
The image is now defined by css class name

Name of the image used to display when overwriting a graph report subscription.
If you have a subscription to a graph report and if you try to create a new subscription to the same report with the same schedule, then we will show you an overwrite confirm message along with this image.

public FormalParameter gridGraphImage

This field is deprecated.
The image is now defined by css class name

Name of the image used to display when overwriting a grid-graph report subscription. If you have a subscription to a grid-graph report and if you try to create a new subscription to the same report with the same schedule, then we will show you an overwrite confirm message along with this image.

public FormalParameter gridImage

This field is deprecated.
The image is now defined by css class name

Name of the image used to display when overwriting a grid report subscription. If you have a subscription to a grid report and if you try to create a new subscription to the same report with the same schedule, then we will show you an overwrite confirm message along with this image.

public FormalParameter objectInfoStyle

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

public FormalParameter rwDocumentImage

This field is deprecated.
The image is now defined by css class name

Name of the image used to display when overwriting a document subscription. If you have a subscription to a document and if you try to create a new subscription to the same document with the same schedule, then we will show you an overwrite confirm message along with this image.

Public Constructors

public ScheduleOverwriteTransform ()

Default no argumnet constructor, initialize formal parameters.

Public Methods

public WebEvent getCancelEvent ()

The event to cancel the subscription.

Returns
  • The EnumScheduleBeanEvents.SCHEDULE_EVENT_CANCEL 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 WebEvent getReturnEvent ()

The event to trigger after the schedule is saved correctly.

Returns
  • The EnumServletEvents.WebEventCancel event (this will automatically go back to the last succesfull page).

public WebEvent getSaveEvent ()

The event to create a new subscription.

Returns
  • The EnumScheduleBeanEvents.SCHEDULE_EVENT_SAVE event.

public Class getSupportedBeanType ()

Returns the supported bean type for the transform.

Returns

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

public void renderDuplicateMessage (MarkupOutput out)

public void renderExecuteButtons (MarkupOutput out)

Renders the "Overwrite" and "Cancel" buttons on the overwrite dialog.

Parameters
out The transform's output.

public void renderFormEnd (MarkupOutput out)

Renders the FORM tag end.

Parameters
out The transform's output.

public void renderFormStart (MarkupOutput out)

Renders the FORM tag start.

Parameters
out The transform's output.

public void renderMessageFooter (MarkupOutput out)

public void renderMessageTitle (MarkupOutput out)

public void renderMobileMessage (MarkupOutput out)

public void renderObjectInfo (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 about overwriting the web schedule.

Parameters
out The transform's output.

public void renderTriggerInfo (MarkupOutput out)

Renders the information about the trigger about to be overwritten.

Parameters
out The transform's output.

public void renderTriggerInfo (MarkupOutput out, WebSchedule ws)

public void transformForRequestSuccessful (MarkupOutput out)

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

Parameters
out Output by this transform

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Transform when the bean status is "WaitingForUserInput". This is the main state when overwriting a new subscrription.

Parameters
out Output by this transform