public class

ScheduleEditTransform

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.ScheduleEditTransform

This class is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use SubscriptionEditTransform instead

Class Overview

This class renders the output to create/edit a WebSchedule (Web-subscription). It supports creating subscriptions for prompted and non-prompted reports. It uses a ScheduleBean for this.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ScheduleEditTransform()
Default no-args constructor, initialize formal parameters.
Public Methods
WebEvent getAddEvent()
The event to create a new scheduled subscription.
SimpleList getAvailableTriggers()
Returns the list of Available triggers.
WebEvent getCancelEvent()
The event to cancel editing the subscription.
String getDescription()
Returns the description of this transform.
PromptsBean getPromptsBean()
Return the PromptsBean associated with the ScheduleBean.
WebEvent getReturnEvent()
The event to trigger after the schedule is saved correctly.
ScheduleWidget getScheduleWidget()
The schedule widget used to enable the user to schedule a report or a document.
Class getSupportedBeanType()
Returns the supported bean type for the transform.
int getViewMode()
The schedule view mode.
void initializeTransform(Transformable data)
Extends initializeTransform by keeping its own copy of the data.
void renderSchedulePane(MarkupOutput out)
Renders the list of schedules for the user to subscribe.
boolean supports(Class type)
Overrrides supports by only supporting ScheduleBean.
Protected Methods
WebEvent getPersonalizationLinkEvent()
WebEvent getUpdatePropertiesEvent()
[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

Public Constructors

public ScheduleEditTransform ()

Default no-args constructor, initialize formal parameters.

Public Methods

public WebEvent getAddEvent ()

The event to create a new scheduled subscription.

Returns
  • The EnumScheduleBeanEvents.SCHEDULE_EVENT_SAVE event.

public SimpleList getAvailableTriggers ()

Returns the list of Available triggers.

Returns
  • The list of Available triggers.

public WebEvent getCancelEvent ()

The event to cancel editing 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 PromptsBean getPromptsBean ()

Return the PromptsBean associated with the ScheduleBean.

Returns

public WebEvent getReturnEvent ()

The event to trigger after the schedule 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 ScheduleWidget getScheduleWidget ()

The schedule widget used to enable the user to schedule a report or a document.

Returns

public Class getSupportedBeanType ()

Returns the supported bean type for the transform.

Returns

public int getViewMode ()

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

Returns
  • The view mode of the schedule.

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

Renders the list of schedules for the user to subscribe. It uses a ScheduleWidget to accomplish this.

Parameters
out The transform output.

public boolean supports (Class type)

Overrrides supports by only supporting ScheduleBean.

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

Protected Methods

protected WebEvent getPersonalizationLinkEvent ()

protected WebEvent getUpdatePropertiesEvent ()