Package com.microstrategy.web.objects

Interface WebScheduleSource

  • public interface WebScheduleSource
    Deprecated.
    Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use WebSubscriptionsSource instead.
    This is the top-level scheduling SDK object. It serves as the entry point for the web scheduling functionality. It provides methods to retrieve, filter and sort existing schedules. It also provides support for adding new schedules to the Intelligence Server.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getBlockBegin

        int getBlockBegin()
        Deprecated.
        Returns the value of blockBegin set on this object. The blockBegin and blockCount parameters are used to incrementally fetch the schedules.
        Returns:
        the value of blockBegin on this object.

      • setBlockBegin

        void setBlockBegin​(int blockBegin)
        Deprecated.
        Sets the value of blockBegin on this object. The blockBegin and blockCount parameters are used to incrementally fetch the schedules.
        Parameters:
        blockBegin - The blockBegin to be set for this object.

      • getBlockCount

        int getBlockCount()
        Deprecated.
        Returns the value of blockCount set on this object. The blockBegin and blockCount parameters are used to incrementally fetch the schedules.
        Returns:
        the value of blockCount on this object.

      • setBlockCount

        void setBlockCount​(int blockCount)
        Deprecated.
        Sets the value of blockCount on this object. The blockBegin and blockCount parameters are used to incrementally fetch the schedules.
        Parameters:
        blockCount - The blockCount to be set for this object.

      • getSortField

        int getSortField()
        Deprecated.
        Retrieves the sorting criterion for the schedules. The possible attributes for sorting are enumerated in EnumWebScheduleSort
        Returns:
        the parameter used to sort the schedules

      • setSortField

        void setSortField​(int flags)
        Deprecated.
        Sets the sorting criterion for the schedules. The possible attributes for sorting are listed in EnumWebScheduleSort
        Parameters:
        flags - the parameter to be used to sort the schedules

      • isSortAscending

        boolean isSortAscending()
        Deprecated.
        Returns true if the sorting is in ascending order.
        Returns:
        true if the sorting if in ascending order.

      • setSortAscending

        void setSortAscending​(boolean asc)
        Deprecated.
        Sets the sorting order.
        Parameters:
        asc - true if the sorting order is ascending.

      • getSchedules

        WebSchedules getSchedules()
                   throws WebObjectsException
        Deprecated.
        Gets all the schedules that the current user has privileges to see. Note that some of these schedules may have been created by a different user The schedules are populated with details from IServer.
        Returns:
        the WebSchedules object
        Throws:
        WebObjectException - whenever there is an error in retrieving information from the Intelligence Server
        WebObjectsException

      • getUserSchedules

        WebSchedules getUserSchedules()
                       throws WebObjectsException
        Deprecated.
        Gets only those schedules that were created by the current user. The schedules are populated with details from IServer.
        Returns:
        the WebSchedules object
        Throws:
        WebObjectException - whenever there is an error in retrieving information from the Intelligence Server
        WebObjectsException

      • getTriggers

        WebFolder getTriggers()
               throws WebObjectsException
        Deprecated.
        Gets the current triggers within the project
        Returns:
        the WebFolder object containing the triggers
        Throws:
        WebObjectException - whenever there is an error in retrieving information from the Intelligence Server
        WebObjectsException

      • getTriggers

        WebFolder getTriggers​(java.lang.String id,
                      int type,
                      java.lang.String projectId)
               throws WebObjectsException
        Deprecated.
        Gets the current triggers within the project
        Parameters:
        id - Object id for content
        type - Object type for content
        projectId - Id of project
        Returns:
        the WebFolder object containing the triggers
        Throws:
        WebObjectException - whenever there is an error in retrieving information from the Intelligence Server
        WebObjectsException

      • restoreScheduleFromState

        WebSchedule restoreScheduleFromState​(java.lang.String state)
                              throws java.lang.IllegalArgumentException
        Deprecated.
        Creates a new WebSchedule object corresponding to the state String passed.
        Parameters:
        state - The state string from which to restore the state for the new WebSchedule object.
        Returns:
        The new WebSchedule object
        Throws:
        java.lang.IllegalArgumentException - if the schedule could not be restored using the state.

      • restoreScheduleFromState

        WebSchedule restoreScheduleFromState​(SAXSupport parser,
                                     java.lang.String uri,
                                     java.lang.String localName,
                                     java.lang.String qName,
                                     org.xml.sax.Attributes attrs)
                              throws java.lang.IllegalArgumentException
        Deprecated.
        Creates a new WebSchedule object using the parser object passed.
        Parameters:
        parser - The parser from which to restore the state for the new WebSchedule object.
        Returns:
        The new WebSchedule object
        Throws:
        java.lang.IllegalArgumentException - if the schedule could not be restored.