public interface

WebSchedule

implements Persistable EditableObject
com.microstrategy.web.objects.WebSchedule

This interface is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please use WebSubscription instead.

Class Overview

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.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebMessages getInboxMessages()
Returns the list of WebMessages in Inbox corresponding to this schedule.
abstract WebRequest getRequest()
Retrieves the request for the schedule
abstract WebScheduleTrigger getTrigger()
Retrieves the trigger for the schedule
abstract boolean isExisting()
indicates whether the schedule is an existing one
abstract void save(boolean overwrite)
saves this schedule
abstract void setTrigger(WebScheduleTrigger trigger)
Adds a trigger for the schedule
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.EditableObject

Public Methods

public abstract WebMessages getInboxMessages ()

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.

public abstract WebRequest getRequest ()

Retrieves the request for the schedule

Returns

public abstract WebScheduleTrigger getTrigger ()

Retrieves the trigger for the schedule

Returns

public abstract boolean isExisting ()

indicates whether the schedule is an existing one

Returns
  • whether the schedule is an existing one

public abstract void save (boolean overwrite)

saves this schedule

Parameters
overwrite boolean indicating whether or not to overwrite an existing schedule previously created with the same object and trigger

public abstract void setTrigger (WebScheduleTrigger trigger)

Adds a trigger for the schedule

Throws
IllegalArgumentException if the trigger passed is invalid (null).