Package com.microstrategy.web.app.transforms

Class SchedulesListXHTMLTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    Direct Known Subclasses:
    SchedulesFilteredListXHTMLTransform
    public class SchedulesListXHTMLTransform
extends AbstractScheduleListTransform
    Deprecated.
    Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please use SubscriptionsListXHTMLTransform instead.
    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.
    Since:
    MicroStrategy Web 8.0.0

    • Constructor Detail

      • SchedulesListXHTMLTransform

        public SchedulesListXHTMLTransform()
        Deprecated.
        Class constructor

    • Method Detail

      • getSummaryText

        public java.lang.String getSummaryText()
        Deprecated.
        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.

      • renderTitle

        public void renderTitle​(MarkupOutput out)
        Deprecated.
        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.

      • generateTable

        protected TableTag generateTable()
        Deprecated.
        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.

      • generateColumnGroup

        protected Tag generateColumnGroup()
        Deprecated.
        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.

      • generateHeadersRow

        protected RowTag generateHeadersRow​(SimpleList list)
        Deprecated.
        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.

      • generateItems

        protected RowTag[] generateItems​(SimpleList list)
        Deprecated.
        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.

      • isSchedulePersonalized

        public boolean isSchedulePersonalized​(WebSchedule schedule,
                                      WebObjectInfo target)
        Deprecated.
        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

      • renderIconInfo

        public void renderIconInfo​(MarkupOutput out,
                           WebSchedule schedule,
                           WebObjectInfo target)
        Deprecated.
        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

      • renderNameInfo

        public void renderNameInfo​(MarkupOutput out,
                           WebSchedule schedule,
                           WebObjectInfo target)
        Deprecated.
        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

      • renderTimeInfo

        public void renderTimeInfo​(MarkupOutput out,
                           WebSchedule schedule,
                           WebObjectInfo target)
        Deprecated.
        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

      • renderPersonalizedInfo

        public void renderPersonalizedInfo​(MarkupOutput out,
                                   WebSchedule schedule,
                                   WebObjectInfo target)
        Deprecated.
        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

      • renderTriggerInfo

        public void renderTriggerInfo​(MarkupOutput out,
                              WebSchedule schedule,
                              WebObjectInfo target)
        Deprecated.
        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

      • renderEditInfo

        public void renderEditInfo​(MarkupOutput out,
                           WebSchedule schedule,
                           WebObjectInfo target)
        Deprecated.
        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

      • renderRemoveInfo

        public void renderRemoveInfo​(MarkupOutput out,
                             WebSchedule schedule,
                             WebObjectInfo target)
        Deprecated.
        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

      • renderFormStart

        public void renderFormStart​(MarkupOutput out)
        Deprecated.
        Renders the FORM tag start information
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.

      • renderFormEnd

        public void renderFormEnd​(MarkupOutput out)
        Deprecated.
        Renders the FORM tag end information.
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.

      • getFieldCount

        protected int getFieldCount()
        Deprecated.
        Obtains the number of columns this transform is displaying, depending on which ones are enabled through the levelFlags formal parameter.
        Overrides:
        getFieldCount in class AbstractSubscriptionFolderBeanTransform
        Returns:
        the number of columns to be displayed by this transform.

      • getDescription

        public java.lang.String getDescription()
        Deprecated.
        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.