public interface

WebSchedules

implements EditableObject
com.microstrategy.web.objects.WebSchedules

This interface is 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.

Class Overview

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.

Summary

Public Methods
abstract WebSchedule add(WebSchedule schedule)
Adds a new WebSchedule object to the collection.
abstract WebSchedule addCopy(WebSchedule schedule)
Creates a copy of the schedule object passed and returns the new (deep) cloned WebSchedule object after adding it to the collection.
abstract void clear()
Clears the schedules collection.
abstract Enumeration elements()
Gets the Enumeration of the WebSchedule objects.
abstract WebSchedule get(int index)
Retrieves the WebSchedule object at the index passed as argument.
abstract int getSortField()
Retrieves the sorting criterion for the WebSchedule objects.
abstract boolean isEmpty()
Checks if the WebSchedules object is empty (without any WebSchedule object)
abstract boolean isSortAscending()
Returns true if the sorting is in ascending order.
abstract void remove(int index)
Removes the WebSchedule object at the index passed.
abstract void setSortAscending(boolean asc)
Sets the sorting order.
abstract void setSortField(int sortFlag)
Sets the sorting criterion for the WebSchedule objects.
abstract int size()
Returns the number of schedules in the collection
abstract void sort()
sorts the WebSchedule objects
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.EditableObject

Public Methods

public abstract WebSchedule add (WebSchedule schedule)

Adds a new WebSchedule object to the collection.

Parameters
schedule WebSchedule object to be added.
Returns
Throws
IllegalArgumentException if the schedule object is invalid(null).

public abstract WebSchedule addCopy (WebSchedule schedule)

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
Throws
IllegalArgumentException if the schedule object is invalid(null).

public abstract void clear ()

Clears the schedules collection. Removes all the WebSchedule objects from the collection This does not actually delete any schedules from the metadata.

public abstract Enumeration elements ()

Gets the Enumeration of the WebSchedule objects.

Returns
  • A collection of the WebSchedule elements within the the current object.

public abstract WebSchedule get (int index)

Retrieves the WebSchedule object at the index passed as argument.

Parameters
index the index for the fetch
Returns
Throws
IndexOutOfBoundsException if the index passed is out of bounds.

public abstract int getSortField ()

Retrieves the sorting criterion for the WebSchedule objects.

Returns
  • the field on which the WebSchedule objects are sorted.

public abstract boolean isEmpty ()

Checks if the WebSchedules object is empty (without any WebSchedule object)

Returns

public abstract boolean isSortAscending ()

Returns true if the sorting is in ascending order.

Returns
  • true if the sorting if in ascending order.

public abstract void remove (int index)

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 save() this collection

Parameters
index the index for the WebSchedule to be deleted
Throws
IndexOutOfBoundsException if the index is invalid

public abstract void setSortAscending (boolean asc)

Sets the sorting order.

Parameters
asc true if the sorting order is ascending.

public abstract void setSortField (int sortFlag)

Sets the sorting criterion for the WebSchedule objects.

Parameters
sortFlag the field on which the WebSchedule objects should be sorted.

public abstract int size ()

Returns the number of schedules in the collection

Returns
  • the number of schedules

public abstract void sort ()

sorts the WebSchedule objects