wt.scheduler
Class SchedulingServiceFwd

java.lang.Object
  extended bywt.scheduler.SchedulingServiceFwd
All Implemented Interfaces:
RemoteAccess, SchedulingService, Serializable

public class SchedulingServiceFwd
extends Object
implements RemoteAccess, SchedulingService, Serializable

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

Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private static String FC_RESOURCE
           
(package private) static boolean SERVER
           
 
Fields inherited from interface wt.method.RemoteAccess
versionID
 
Constructor Summary
SchedulingServiceFwd()
           
 
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
private static Manager getManager()
           
 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SERVER

static final boolean SERVER

FC_RESOURCE

private static final String FC_RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME
Constructor Detail

SchedulingServiceFwd

public SchedulingServiceFwd()
Method Detail

getManager

private static Manager getManager()
                           throws WTException
Returns:
Manager
Throws:
WTException

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

Specified by:
getScheduleItems in interface SchedulingService
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

Specified by:
addItem in interface SchedulingService
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

Specified by:
cancelItem in interface SchedulingService
Parameters:
theItem -
Throws:
WTException

modifyItem

public ScheduleItem modifyItem(ScheduleItem theItem)
                        throws WTException


Supported API: false

Specified by:
modifyItem in interface SchedulingService
Parameters:
theItem -
Returns:
ScheduleItem
Throws:
WTException

startExecution

public void startExecution(ScheduleItem item)
                    throws WTException


Supported API: false

Specified by:
startExecution in interface SchedulingService
Parameters:
item -
Throws:
WTException

getItemMethodArguments

public MethodArgument[] getItemMethodArguments(ScheduleItem theItem)
                                        throws WTException


Supported API: false

Specified by:
getItemMethodArguments in interface SchedulingService
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

Specified by:
getItemMethodArgs in interface SchedulingService
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

Specified by:
getItemHistories in interface SchedulingService
Parameters:
theItem -
Returns:
Enumeration
Throws:
WTException

removeItem

public void removeItem(ScheduleItem item)
                throws WTException
Removes a Schedule item

Supported API: false

Specified by:
removeItem in interface SchedulingService
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

Specified by:
executeItemImmediately in interface SchedulingService
Parameters:
item -
Returns:
ScheduleItem
Throws:
WTException