Interface WebSchedule

  • All Superinterfaces:
    EditableObject, EnumWebPersistableState, Persistable

    public interface WebSchedule
    extends EditableObject, Persistable
    Deprecated.
    Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please use WebSubscription instead.
    This class holds the information regarding a Web Schedule. A Schedule object is EditableObject and Persistable.

    A schedule object comprises of a schedule trigger object and a request object. The schedule trigger object (WebScheduleTrigger) defines when the schedule is triggered and the request object (WebRequest) defines the command the server will execute. The request object consists of a statement which used to define the server command.

    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Method Detail

      • setTrigger

        void setTrigger​(WebScheduleTrigger trigger)
                 throws java.lang.IllegalArgumentException
        Deprecated.
        Adds a trigger for the schedule
        Throws:
        java.lang.IllegalArgumentException - if the trigger passed is invalid (null).
      • getRequest

        WebRequest getRequest()
        Deprecated.
        Retrieves the request for the schedule
        Returns:
        WebRequest object for the schedule
      • isExisting

        boolean isExisting()
        Deprecated.
        indicates whether the schedule is an existing one
        Returns:
        whether the schedule is an existing one
      • getInboxMessages

        WebMessages getInboxMessages()
                              throws WebObjectsException
        Deprecated.
        Returns the list of WebMessages in Inbox corresponding to this schedule.
        Returns:
        The messages in Inbox corresponding to this schedule.
        Throws:
        WebObjectsException - if an error is encountered while retrieving messages from Inbox.
      • save

        void save​(boolean overwrite)
           throws WebObjectsException
        Deprecated.
        saves this schedule
        Parameters:
        overwrite - boolean indicating whether or not to overwrite an existing schedule previously created with the same object and trigger
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 8.0.0