com.sapportals.wcm.service.scheduler

Interface ISchedulerEntry

All Superinterfaces:

IComponent

public interface ISchedulerEntry
extends IComponent

Scheduler entries contain data for scheduler tasks.

An ISchedulerEntry represents an entry in the IScheduler's internal list. Each entry has a unique id, specifies the task to execute and a timetable, which specifies the scheduling timetable (when to execute the task). In addition, there might be some (String-)parameters for the task, passed as properties.

Copyright 2004 SAP AG

See Also:

ISchedulerService

Method Summary

String	getID() Get the unique id of the entry.
int	getPriority() Get the priority of the entry.
Properties	getProperties() Get the properties to pass to the task of the entry.
ISystemList	getSystemList() Gets the ID of the CM system where to run the ISchedulerTask physically.
ISchedulerTask	getTask() Get the task for the entry.
ISchedulerTimeTable	getTimeTable() Get the timetable for the entry.
boolean	isRunning() Check if the entry is running(currently being executed).
boolean	isSuspended() Check if the entry is suspended (currently inactive and not waiting).
boolean	isWaiting() Check if the entry is not suspended and not active.
void	setPriority(int priority) Set the priority of the entry.
void	setProperties(Properties properties) Set the entry's properties to pass to the task.
void	setSystemList(ISystemList systemList) Sets the ID of the CM system where to run the ISchedulerTask physically.
void	setTask(ISchedulerTask task) Set the entry's task.
void	setTimeTable(ISchedulerTimeTable timetable) Set the entry's timetable.

Method Detail

getID

String getID()

Get the unique id of the entry.

Returns:

a String with the entry's id.

getPriority

int getPriority()

Get the priority of the entry.

Returns:

an int with the entry's priority (a higher value is a higher priority).

setPriority

void setPriority(int priority)
                 throws com.sapportals.wcm.WcmException

Set the priority of the entry.

Parameters:

priority - an int with the entry's priority (a higher value is a higher priority).

Throws:

com.sapportals.wcm.WcmException

isRunning

boolean isRunning()
                  throws com.sapportals.wcm.WcmException

Check if the entry is running(currently being executed).

Returns:

a boolean true, if the entry's task is currently being executed, false if not.

Throws:

com.sapportals.wcm.WcmException - if the state could not be determined.

isSuspended

boolean isSuspended()
                    throws com.sapportals.wcm.WcmException

Check if the entry is suspended (currently inactive and not waiting).

Returns:

a boolean true, if the entry's task is suspended, false if not.

Throws:

com.sapportals.wcm.WcmException - if the state could not be determined.

isWaiting

boolean isWaiting()
                  throws com.sapportals.wcm.WcmException

Check if the entry is not suspended and not active.

Returns:

a boolean true, if the entry's task is currently neither being executed nor suspended, false if not.

Throws:

com.sapportals.wcm.WcmException - if the state could not be determined.

getTask

ISchedulerTask getTask()
                       throws com.sapportals.wcm.WcmException

Get the task for the entry.

Returns:

an ISchedulerTask with the task.

Throws:

com.sapportals.wcm.WcmException - if the task could not be retrieved.

setTask

void setTask(ISchedulerTask task)
             throws com.sapportals.wcm.WcmException

Set the entry's task.

Parameters:

task - an ISchedulerTask with the task to execute.

Throws:

com.sapportals.wcm.WcmException - if the scheduler entry could not be updated.

getTimeTable

ISchedulerTimeTable getTimeTable()
                                 throws com.sapportals.wcm.WcmException

Get the timetable for the entry.

Returns:

an ISchedulerTimeTable with the timetable.

Throws:

com.sapportals.wcm.WcmException - if the timetable could not be retrieved.

setTimeTable

void setTimeTable(ISchedulerTimeTable timetable)
                  throws com.sapportals.wcm.WcmException

Set the entry's timetable.

Parameters:

timetable - an ISchedulerTimeTable with the timetable to use.

Throws:

com.sapportals.wcm.WcmException - if the timetable could not be set

getProperties

Properties getProperties()
                         throws com.sapportals.wcm.WcmException

Get the properties to pass to the task of the entry.

Returns:

the Properties for the task.

Throws:

com.sapportals.wcm.WcmException - if the properties could not be retrieved.

setProperties

void setProperties(Properties properties)
                   throws com.sapportals.wcm.WcmException

Set the entry's properties to pass to the task.

Parameters:

properties - the Properties for the task.

Throws:

com.sapportals.wcm.WcmException - if the properties could not be set.

getSystemList

ISystemList getSystemList()

Gets the ID of the CM system where to run the ISchedulerTask physically.

Returns:

the ID of the CM system where to run the ISchedulerTask physically.

setSystemList

void setSystemList(ISystemList systemList)
                   throws com.sapportals.wcm.WcmException

Sets the ID of the CM system where to run the ISchedulerTask physically.

Parameters:

systemList - The new systemList value

Throws:

com.sapportals.wcm.WcmException - if the system list could not be set.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM