Package com.microstrategy.web.objects

Interface WebSchedules

  • All Superinterfaces:
    EditableObject
    public interface WebSchedules
extends EditableObject
    Deprecated.
    Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. There is no equivalent collection class for subscription objects.
    This class holds a collection of WebSchedule Objects. It provides methods to add new schedules to this collection, view, sort and delete them. Note that any changes to the collection are done in memory. You can persist them to the server by explicitly calling save or delete.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • add

        WebSchedule add​(WebSchedule schedule)
         throws java.lang.IllegalArgumentException
        Deprecated.
        Adds a new WebSchedule object to the collection.
        Parameters:
        schedule - WebSchedule object to be added.
        Returns:
        The newly added WebSchedule object
        Throws:
        java.lang.IllegalArgumentException - if the schedule object is invalid(null).

      • addCopy

        WebSchedule addCopy​(WebSchedule schedule)
             throws java.lang.IllegalArgumentException
        Deprecated.
        Creates a copy of the schedule object passed and returns the new (deep) cloned WebSchedule object after adding it to the collection. Note that the trigger from the original schedule is not copied
        Parameters:
        schedule - The WebSchedule object to be copied.
        Returns:
        The copied WebSchedule object.
        Throws:
        java.lang.IllegalArgumentException - if the schedule object is invalid(null).

      • get

        WebSchedule get​(int index)
         throws java.lang.IndexOutOfBoundsException
        Deprecated.
        Retrieves the WebSchedule object at the index passed as argument.
        Parameters:
        index - the index for the fetch
        Returns:
        the WebSchedule object at the given index
        Throws:
        java.lang.IndexOutOfBoundsException - if the index passed is out of bounds.

      • remove

        void remove​(int index)
     throws java.lang.IndexOutOfBoundsException
        Deprecated.
        Removes the WebSchedule object at the index passed. This does not actually delete the corresponding schedule. It only removes it from the collection. The schedule would be deleted if there is a subsequent call to EditableObject.save() this collection
        Parameters:
        index - the index for the WebSchedule to be deleted
        Throws:
        java.lang.IndexOutOfBoundsException - if the index is invalid

      • clear

        void clear()
        Deprecated.
        Clears the schedules collection. Removes all the WebSchedule objects from the collection This does not actually delete any schedules from the metadata.

      • size

        int size()
        Deprecated.
        Returns the number of schedules in the collection
        Returns:
        the number of schedules

      • getSortField

        int getSortField()
        Deprecated.
        Retrieves the sorting criterion for the WebSchedule objects.
        Returns:
        the field on which the WebSchedule objects are sorted.

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

      • sort

        void sort()
        Deprecated.
        sorts the WebSchedule objects

      • elements

        java.util.Enumeration elements()
        Deprecated.
        Gets the Enumeration of the WebSchedule objects.
        Returns:
        A collection of the WebSchedule elements within the the current object.