public interface

WebScheduleSource

com.microstrategy.web.objects.WebScheduleSource

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

Class Overview

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.

Summary

Public Methods
abstract int getBlockBegin()
Returns the value of blockBegin set on this object.
abstract int getBlockCount()
Returns the value of blockCount set on this object.
abstract WebSchedule getNewScheduleObject(WebObjectInfo object)
Returns a new WebSchedule object with the schedule object passed.
abstract WebSchedule getNewScheduleObject(WebObjectInfo object, WebScheduleTrigger trigger)
Returns a new WebSchedule object with WebObjectInfo object passed as the target and WebScheduleTrigger trigger.
abstract WebSchedules getNewSchedulesObject()
Returns a new WebSchedules object which is empty.
abstract WebSchedules getSchedules()
Gets all the schedules that the current user has privileges to see.
abstract WebSchedules getSchedules(WebObjectInfo object)
Gets the current schedules for the object passed.
abstract int getSortField()
Retrieves the sorting criterion for the schedules.
abstract WebFolder getTriggers()
Gets the current triggers within the project
abstract WebFolder getTriggers(String id, int type, String projectId)
Gets the current triggers within the project
abstract WebSchedule getUserSchedule(WebObjectInfo object, WebScheduleTrigger trigger, boolean populate)
Creates a WebSchedule object for the user corresponding to an existing schedule on IServer.
abstract WebSchedule getUserSchedule(WebObjectInfo object, WebScheduleTrigger trigger)
Creates a WebSchedule object for the user corresponding an existing schedule on IServer.
abstract WebSchedules getUserSchedules(WebObjectInfo object)
Gets only those schedules that were created by the current user that match the filtering restriction placed by passing in a certain object.
abstract WebSchedules getUserSchedules()
Gets only those schedules that were created by the current user.
abstract boolean isSortAscending()
Returns true if the sorting is in ascending order.
abstract WebSchedule restoreScheduleFromState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs)
Creates a new WebSchedule object using the parser object passed.
abstract WebSchedule restoreScheduleFromState(String state)
Creates a new WebSchedule object corresponding to the state String passed.
abstract void setBlockBegin(int blockBegin)
Sets the value of blockBegin on this object.
abstract void setBlockCount(int blockCount)
Sets the value of blockCount on this object.
abstract void setSortAscending(boolean asc)
Sets the sorting order.
abstract void setSortField(int flags)
Sets the sorting criterion for the schedules.

Public Methods

public abstract int getBlockBegin ()

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.

public abstract int getBlockCount ()

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.

public abstract WebSchedule getNewScheduleObject (WebObjectInfo object)

Returns a new WebSchedule object with the schedule object passed. Allowed object types are DssXmlTypeScheduleTrigger, DssXmlTypeReportDefinition & DssXmlTypeDocumentDefinition.

Returns
Throws
IllegalArgumentException if the target passed is invalid.

public abstract WebSchedule getNewScheduleObject (WebObjectInfo object, WebScheduleTrigger trigger)

Returns a new WebSchedule object with WebObjectInfo object passed as the target and WebScheduleTrigger trigger.

Returns
Throws
IllegalArgumentException if the target passed is invalid.

public abstract WebSchedules getNewSchedulesObject ()

Returns a new WebSchedules object which is empty. WebSchedule objects can be added to it using the add(WebSchedule) method

Returns

public abstract WebSchedules getSchedules ()

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
Throws
whenever there is an error in retrieving information from the Intelligence Server
WebObjectsException

public abstract WebSchedules getSchedules (WebObjectInfo object)

Gets the current schedules for the object passed. The schedules are populated with details from IServer. The returned list includes all the schedules that the current user has access to. Allowed object types for the objects that passed in as an argument are

Returns
Throws
whenever there is an error in retrieving information from the Intelligence Server
WebObjectsException

public abstract int getSortField ()

Retrieves the sorting criterion for the schedules. The possible attributes for sorting are enumerated in EnumWebScheduleSort

Returns
  • the parameter used to sort the schedules

public abstract WebFolder getTriggers ()

Gets the current triggers within the project

Returns
Throws
whenever there is an error in retrieving information from the Intelligence Server
WebObjectsException

public abstract WebFolder getTriggers (String id, int type, String projectId)

Gets the current triggers within the project

Parameters
id Object id for content
type Object type for content
projectId Id of project
Returns
Throws
whenever there is an error in retrieving information from the Intelligence Server
WebObjectsException

public abstract WebSchedule getUserSchedule (WebObjectInfo object, WebScheduleTrigger trigger, boolean populate)

Creates a WebSchedule object for the user corresponding to an existing schedule on IServer. Thus, this call is intended to be used only when the caller is sure that the user schedule with object and trigger passed exist on the IServer. Also, based on the value of populate, a call is made to IServer to populate such a WebSchedule. Allowed object types are DssXmlTypeScheduleTrigger, DssXmlTypeReportDefinition & DssXmlTypeDocumentDefinition

Returns
  • a WebSchedule object with the passed information and populated with details based on the value of populate.
Throws
if there is an error in populating the details from IServer.
IllegalArgumentException if the object and trigger passed are invalid(null).
WebObjectsException

public abstract WebSchedule getUserSchedule (WebObjectInfo object, WebScheduleTrigger trigger)

Creates a WebSchedule object for the user corresponding an existing schedule on IServer. Thus, this call is intended to be used only when the caller is sure that the user schedule with object and trigger passed exist on the IServer. Also, no call is made to IServer to populate such a WebSchedule. Allowed object types are DssXmlTypeScheduleTrigger, DssXmlTypeReportDefinition & DssXmlTypeDocumentDefinition

Returns
Throws
whenever there is an error.
IllegalArgumentException if the object and trigger passed are invalid(null).
WebObjectsException

public abstract WebSchedules getUserSchedules (WebObjectInfo object)

Gets only those schedules that were created by the current user that match the filtering restriction placed by passing in a certain object. These schedules returned are only those that were created by the current user. The schedules are populated with details from IServer. Allowed object types for the objects that passed in as an argument are

Returns
Throws
whenever there is an error in retrieving information from the Intelligence Server
WebObjectsException

public abstract WebSchedules getUserSchedules ()

Gets only those schedules that were created by the current user. The schedules are populated with details from IServer.

Returns
Throws
whenever there is an error in retrieving information from the Intelligence Server
WebObjectsException

public abstract boolean isSortAscending ()

Returns true if the sorting is in ascending order.

Returns
  • true if the sorting if in ascending order.

public abstract WebSchedule restoreScheduleFromState (SAXSupport parser, String uri, String localName, String qName, Attributes attrs)

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
Throws
IllegalArgumentException if the schedule could not be restored.

public abstract WebSchedule restoreScheduleFromState (String state)

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
Throws
IllegalArgumentException if the schedule could not be restored using the state.

public abstract void setBlockBegin (int blockBegin)

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.

public abstract void setBlockCount (int blockCount)

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.

public abstract void setSortAscending (boolean asc)

Sets the sorting order.

Parameters
asc true if the sorting order is ascending.

public abstract void setSortField (int flags)

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