Package com.microstrategy.web.objects

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

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
WebMessages	getInboxMessages()	Deprecated. Returns the list of WebMessages in Inbox corresponding to this schedule.
WebRequest	getRequest()	Deprecated. Retrieves the request for the schedule
WebScheduleTrigger	getTrigger()	Deprecated. Retrieves the trigger for the schedule
boolean	isExisting()	Deprecated. indicates whether the schedule is an existing one
void	save(boolean overwrite)	Deprecated. saves this schedule
void	setTrigger(WebScheduleTrigger trigger)	Deprecated. Adds a trigger for the schedule

Methods inherited from interface com.microstrategy.web.objects.EditableObject

delete, save, save

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Method Detail

getTrigger

WebScheduleTrigger getTrigger()

Deprecated.

Retrieves the trigger for the schedule

Returns:

WebScheduleTrigger object for the schedule

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