public abstract class

AbstractScheduleListTransform

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

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

Class Overview

This is the Abstract class for rendering Web Schedules (normal Web-Subscriptions).

Summary

Constants
int LEVEL_TRIGGER Indicates to show the trigger (schedule) of a subscription.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected final int VIEW_MODE_CUBE
protected final int VIEW_MODE_DATAMART
protected final int VIEW_MODE_DOCUMENT
protected final int VIEW_MODE_GRAPH
protected final int VIEW_MODE_GRID
protected final int VIEW_MODE_GRID_GRAPH
protected final int VIEW_MODE_RW_DOCUMENT
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractScheduleListTransform()
Default no-arg constructor
Public Methods
boolean canTransform(Transformable data)
Overrides canTransform(Transformable) by making sure the SubscriptionFolderBean is set to return a list of WebSchedules.
Protected Methods
String getCssName(WebSchedule schedule)
Get the css class name to use depending of the schedule type being rendered
String getEmptyListDescriptor()
WebEvent getExecuteEvent(WebSchedule schedule)
String getMessageId(WebSchedule schedule)
Returns the current inbox message ID being used by this schedule, if applicable.
String getMessageTime(WebSchedule schedule)
Returns the time when the message accociated with the schudule was run
WebEvent getReportExecuteEvent(boolean messagePresent)
WebObjectInfo getScheduleTarget(WebSchedule schedule)
Returns the target object info associated with the given schedule
int getViewMode(WebSchedule schedule)
The schedule view mode
boolean isValidSchedule(WebSchedule schedule)
Checks if the schedule is valid and should be displayed
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
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 int LEVEL_TRIGGER

Indicates to show the trigger (schedule) of a subscription.

Constant Value: 256 (0x00000100)

Fields

protected final int VIEW_MODE_CUBE

Constant Value: 6 (0x00000006)

protected final int VIEW_MODE_DATAMART

Constant Value: 5 (0x00000005)

protected final int VIEW_MODE_DOCUMENT

Constant Value: 3 (0x00000003)

protected final int VIEW_MODE_GRAPH

Constant Value: 1 (0x00000001)

protected final int VIEW_MODE_GRID

Constant Value: 0 (0x00000000)

protected final int VIEW_MODE_GRID_GRAPH

Constant Value: 2 (0x00000002)

protected final int VIEW_MODE_RW_DOCUMENT

Constant Value: 4 (0x00000004)

Public Constructors

public AbstractScheduleListTransform ()

Default no-arg constructor

Public Methods

public boolean canTransform (Transformable data)

Overrides canTransform(Transformable) by making sure the SubscriptionFolderBean is set to return a list of WebSchedules.

Parameters
data the SubscripptionFolderBean to transform
Returns
  • true if the getContentType() method returns SubscriptionFolderBean.SUBSCRIPTION_FOLDER_CONTENT_TYPE_SCHEDULE

Protected Methods

protected String getCssName (WebSchedule schedule)

Get the css class name to use depending of the schedule type being rendered

Parameters
schedule WebSchedule instance to check for its view mode type
Returns
  • the String with the css class to use depending on the schedule type.

protected String getEmptyListDescriptor ()

protected WebEvent getExecuteEvent (WebSchedule schedule)

Parameters
schedule the schedule object to execute
Returns
  • a WebEvent to execute the message (i.e., runReports)
    The event used to execute the subscription

protected String getMessageId (WebSchedule schedule)

Returns the current inbox message ID being used by this schedule, if applicable.

Parameters
schedule schedule object.
Returns
  • An inbox message ID.

protected String getMessageTime (WebSchedule schedule)

Returns the time when the message accociated with the schudule was run

Parameters
schedule the schedule object
Returns
  • The time when the message accociated with the schudule was run

protected WebEvent getReportExecuteEvent (boolean messagePresent)

protected WebObjectInfo getScheduleTarget (WebSchedule schedule)

Returns the target object info associated with the given schedule

Parameters
schedule schedule id.
Returns
  • the objectinfo (populated) that is the target of the given schedule.

protected int getViewMode (WebSchedule schedule)

The schedule view mode

Parameters
schedule the schedule to check

protected boolean isValidSchedule (WebSchedule schedule)

Checks if the schedule is valid and should be displayed

Parameters
schedule the schedule to check
Returns
  • true if it has a trigger and a target, and if the target is not a Datamart.