public interface ISchedulerEntry extends IComponent
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
ISchedulerService
Modifier and Type | Method and Description |
---|---|
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.
|
String getID()
String
with the entry's id.int getPriority()
int
with the entry's priority (a higher value
is a higher priority).void setPriority(int priority) throws WcmException
priority
- an int
with the entry's priority (a higher
value is a higher priority).WcmException
- exceptionboolean isRunning() throws WcmException
boolean
true
, if the entry's task
is currently being executed, false
if not.WcmException
- if the state could not be determined.boolean isSuspended() throws WcmException
boolean
true
, if the entry's task
is suspended, false
if not.WcmException
- if the state could not be determined.boolean isWaiting() throws WcmException
boolean
true
, if the entry's task
is currently neither being executed nor suspended,
false
if not.WcmException
- if the state could not be determined.ISchedulerTask getTask() throws WcmException
ISchedulerTask
with the task.WcmException
- if the task could not be retrieved.void setTask(ISchedulerTask task) throws WcmException
task
- an ISchedulerTask
with the task to execute.WcmException
- if the scheduler entry could not be updated.ISchedulerTimeTable getTimeTable() throws WcmException
ISchedulerTimeTable
with the timetable.WcmException
- if the timetable could not be retrieved.void setTimeTable(ISchedulerTimeTable timetable) throws WcmException
timetable
- an ISchedulerTimeTable
with the timetable
to use.WcmException
- if the timetable could not be setProperties getProperties() throws WcmException
Properties
for the task.WcmException
- if the properties could not be retrieved.void setProperties(Properties properties) throws WcmException
properties
- the Properties
for the task.WcmException
- if the properties could not be set.ISystemList getSystemList()
ISchedulerTask
physically.ISchedulerTask
physically.void setSystemList(ISystemList systemList) throws WcmException
ISchedulerTask
physically.systemList
- The new systemList valueWcmException
- if the system list could not be set.Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice