wt.scheduler
Interface SchedulingService

All Known Implementing Classes:

SchedulingServiceFwd, StandardSchedulingService

public interface SchedulingService

The standard scheduling servide presents a client accessible API to functions provided in the server by the StandardSchedulingService

Supported API: false

Extendable: false

Method Summary

ScheduleItem	addItem(ScheduleItem newItem, ScheduleMethodArg[] itemArgs) This adds a ScheduleItem to the system.
void	cancelItem(ScheduleItem theItem) Cancels a schedule item.
ScheduleItem	executeItemImmediately(ScheduleItem item) Executes an existing Schedule Item immediately. If item doesn't exist, it raises WTException.
Enumeration	getItemHistories(ScheduleItem theItem) Returns an enumeration containing all the history items for a given schedule item.
Enumeration	getItemMethodArgs(ScheduleItem theItem) Returns an Enumeration of the ScheduleMethodArgs referred to by the argument ScheduleItem.
MethodArgument[]	getItemMethodArguments(ScheduleItem theItem) Supported API: false
Enumeration	getScheduleItems(QuerySpec filter) Returns schedule items which satisfy the query spec.
ScheduleItem	modifyItem(ScheduleItem theItem) Supported API: false
void	removeItem(ScheduleItem item) Removes a Schedule item Supported API: false
void	startExecution(ScheduleItem item) Supported API: false

Method Detail

getScheduleItems

public Enumeration getScheduleItems(QuerySpec filter)
                             throws WTException

Returns schedule items which satisfy the query spec. If the filter is null, it returns all ScheduleItems in the system.

Supported API: false

Parameters:

filter -

Returns:

Enumeration

Throws:

WTException

addItem

public ScheduleItem addItem(ScheduleItem newItem,
                            ScheduleMethodArg[] itemArgs)
                     throws WTException

This adds a ScheduleItem to the system. Its argument was created by the client.

Supported API: false

Parameters:

newItem -

itemArgs -

Returns:

ScheduleItem

Throws:

WTException

cancelItem

public void cancelItem(ScheduleItem theItem)
                throws WTException

Cancels a schedule item. This will not cause a deletion of the schedule item or its history.

Supported API: false

Parameters:

theItem -

Throws:

WTException

modifyItem

public ScheduleItem modifyItem(ScheduleItem theItem)
                        throws WTException

Supported API: false

Parameters:

theItem -

Returns:

ScheduleItem

Throws:

WTException

startExecution

public void startExecution(ScheduleItem item)
                    throws WTException

Supported API: false

Parameters:

item -

Throws:

WTException

getItemMethodArguments

public MethodArgument[] getItemMethodArguments(ScheduleItem theItem)
                                        throws WTException

Supported API: false

Parameters:

theItem -

Returns:

MethodArgument[]

Throws:

WTException

getItemMethodArgs

public Enumeration getItemMethodArgs(ScheduleItem theItem)
                              throws WTException

Returns an Enumeration of the ScheduleMethodArgs referred to by the argument ScheduleItem.

Supported API: false

Parameters:

theItem -

Returns:

Enumeration

Throws:

WTException

getItemHistories

public Enumeration getItemHistories(ScheduleItem theItem)
                             throws WTException

Returns an enumeration containing all the history items for a given schedule item. If the filter is null, it returns the ScheduleHistory for all Schedule items in the system.

Supported API: false

Parameters:

theItem -

Returns:

Enumeration

Throws:

WTException

removeItem

public void removeItem(ScheduleItem item)
                throws WTException

Removes a Schedule item

Supported API: false

Parameters:

item -

Throws:

WTException

executeItemImmediately

public ScheduleItem executeItemImmediately(ScheduleItem item)
                                    throws WTException

Executes an existing Schedule Item immediately. If item doesn't exist, it raises WTException.

Supported API: false

Parameters:

item -

Returns:

ScheduleItem

Throws:

WTException