public class

SchedulesListXHTMLTransform

extends AbstractScheduleListTransform
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
             ↳ com.microstrategy.web.app.transforms.SchedulesListXHTMLTransform
Known Direct 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 SubscriptionsListXHTMLTransform instead.

Class Overview

This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean.
The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.

Summary

Constants
int LEVEL_HEADERS
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractScheduleListTransform
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractScheduleListTransform
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SchedulesListXHTMLTransform()
Class constructor
Public Methods
String getDescription()
Returns the description of this transform to be used by the Style Catalog.
String getSummaryText()
Obtain the summary string to display on the table containing the list of objects corresponding to the bean being transformed
boolean isSchedulePersonalized(WebSchedule schedule, WebObjectInfo target)
Determines if the schedule being analyzed has been personalized or not
void renderEditInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the link to edit the schedule being displayed
void renderEmptyList(MarkupOutput out)
Renders the HTML when there are no schedules to display.
void renderFormEnd(MarkupOutput out)
Renders the FORM tag end information.
void renderFormStart(MarkupOutput out)
Renders the FORM tag start information
void renderIconInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the icon information associated with the schedule to display.
void renderList(MarkupOutput out, SimpleList list)
Renders the list of elements available in the SubscriptionFolderBean being transformed
void renderNameInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the name of the schedule's target being displayed.
void renderPersonalizedInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the information whether the schedule is personlized or not (i.e., it is prompted)
void renderRemoveInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the checkbox to remove the schedule being displayed
void renderTimeInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the message execution time for the schedule being displayed.
void renderTitle(MarkupOutput out)
Render a main title associated with this transform.
void renderTriggerInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the schedule's trigger information
Protected Methods
Tag generateColumnGroup()
Generates a COLGROUP HTML tag with COL tags defined for each one of the columns to be rendered on this list view transform.
RowTag generateHeadersRow(SimpleList list)
Generates a TR HTML tag with TD tags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to the level formal parameter.
RowTag generateItem(WebSchedule schedule, WebObjectInfo target)
Generates the RowTag instance corresponding to the information of the WebSchedule and WebObjectInfo sent in as parameters.
RowTag[] generateItems(SimpleList list)
Analyzes all the items available to display and generates an array of RowTag instances (corresponding to TR HTML tags) with the information.
TableTag generateTable()
Generates a TABLE HTML tag where all the contents of the transform to display will be added as rows of this table.
int getFieldCount()
Obtains the number of columns this transform is displaying, depending on which ones are enabled through the levelFlags formal parameter.
WebEvent getRemoveEvent()
Provides the remove event for the given list
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractScheduleListTransform
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_HEADERS

Constant Value: 128 (0x00000080)

Public Constructors

public SchedulesListXHTMLTransform ()

Class constructor

Public Methods

public String getDescription ()

Returns the description of this transform to be used by the Style Catalog.

Returns
  • the description of this transform to be used by the Style Catalog.

public String getSummaryText ()

Obtain the summary string to display on the table containing the list of objects corresponding to the bean being transformed

Returns
  • String with the summary description for the table to render.

public boolean isSchedulePersonalized (WebSchedule schedule, WebObjectInfo target)

Determines if the schedule being analyzed has been personalized or not

Parameters
schedule WebSchedule instance to be tested
target WebObjectInfo instance target of the schedule being analyzed
Returns
  • boolean value indicating if the schedule is personalized or not

public void renderEditInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

Renders the link to edit the schedule being displayed

Parameters
out MarkupOutput instance where the transform's output will be saved.
schedule WebSchedule instance to render
target WebObjectInfo instance target of the schedule being rendered

public void renderEmptyList (MarkupOutput out)

Renders the HTML when there are no schedules to display.

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderFormEnd (MarkupOutput out)

Renders the FORM tag end information.

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderFormStart (MarkupOutput out)

Renders the FORM tag start information

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderIconInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

Renders the icon information associated with the schedule to display.

Parameters
out MarkupOutput instance where the transform's output will be saved.
schedule WebSchedule instance to render
target WebObjectInfo instance target of the schedule being rendered

public void renderList (MarkupOutput out, SimpleList list)

Renders the list of elements available in the SubscriptionFolderBean being transformed

Parameters
out MarkupOutput instance where the transform's output will be saved.
list a SimpleList instance with the list of schedules to render.

public void renderNameInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

Renders the name of the schedule's target being displayed.

Parameters
out MarkupOutput instance where the transform's output will be saved.
schedule WebSchedule instance to render
target WebObjectInfo instance target of the schedule being rendered

public void renderPersonalizedInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

Renders the information whether the schedule is personlized or not (i.e., it is prompted)

Parameters
out MarkupOutput instance where the transform's output will be saved.
schedule WebSchedule instance to render
target WebObjectInfo instance target of the schedule being rendered

public void renderRemoveInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

Renders the checkbox to remove the schedule being displayed

Parameters
out MarkupOutput instance where the transform's output will be saved.
schedule WebSchedule instance to render
target WebObjectInfo instance target of the schedule being rendered

public void renderTimeInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

Renders the message execution time for the schedule being displayed.

Parameters
out MarkupOutput instance where the transform's output will be saved.
schedule WebSchedule instance to render
target WebObjectInfo instance target of the schedule being rendered

public void renderTitle (MarkupOutput out)

Render a main title associated with this transform. By default, nothing is displayed.

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderTriggerInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

Renders the schedule's trigger information

Parameters
out MarkupOutput instance where the transform's output will be saved.
schedule WebSchedule instance to render
target WebObjectInfo instance target of the schedule being rendered

Protected Methods

protected Tag generateColumnGroup ()

Generates a COLGROUP HTML tag with COL tags defined for each one of the columns to be rendered on this list view transform. For example, the content might look like this:

   <colgroup>
     <col class=typ />
     <col class=nam />
     <col class=trg />
     <col class=tim />
     <col class=per />
   </colgroup>
 

Returns
  • Tag instance corresponding to the COLGROUP HTML tag.

protected RowTag generateHeadersRow (SimpleList list)

Generates a TR HTML tag with TD tags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to the level formal parameter. For example, the content might look like this:

   <tr>
     <td> </td>
     <td>Name</td>
     <td>Schedule</td>
     <td>Last Execution Time</td>
     <td>Personalized</td>
   </tr>
 

Parameters
list SimpleList instance with the elements to render.
Returns
  • RowTag instance corresponding to the TR HTML tag where the headers were defined.

protected RowTag generateItem (WebSchedule schedule, WebObjectInfo target)

Generates the RowTag instance corresponding to the information of the WebSchedule and WebObjectInfo sent in as parameters.

Parameters
schedule WebSchedule instance to render
target WebObjectInfo instance target of the schedule being rendered
Returns
  • a RowTag (TR HTML tag) with the information about the WebSchedule and WebObjectInfo target instances requested contained on CellTag child instances. For example, icon image, name, trigger information, etc.

protected RowTag[] generateItems (SimpleList list)

Analyzes all the items available to display and generates an array of RowTag instances (corresponding to TR HTML tags) with the information.

Parameters
list SimpleList instance with the elements to render.
Returns
  • RowTag[] an array of RowTag instances, each one with the information of one object on the list being transformed. If no object is found to render, returns null.

protected TableTag generateTable ()

Generates a TABLE HTML tag where all the contents of the transform to display will be added as rows of this table. Basic HTML attributes are defined to it, such as class.

Returns
  • a TableTag instance defined, by default no rows or other information are added to it. Methods like generateHeadersRow and generateItems should be called for obtaining the information that shall be added to it.

protected int getFieldCount ()

Obtains the number of columns this transform is displaying, depending on which ones are enabled through the levelFlags formal parameter.

Returns
  • the number of columns to be displayed by this transform.

protected WebEvent getRemoveEvent ()

Provides the remove event for the given list

Returns