public interface ISchedulerTimeTable
An ISchedulerTimeTable
represents a timetable which specifies
the times, when an ISchedulerTask
has to be executed by the
IScheduler
. Such a timetable can have a start- and/or an end-
time and at least one ISchedulerTime
which defines the
times.
Simply think of it like a school timetable, where the several entries (the
times) denote repeating lessings.
Copyright 2004 SAP AG
ISchedulerService
,
ISchedulerTime
Modifier and Type | Method and Description |
---|---|
void |
addToTable(ISchedulerTime time)
Add an time to the times of the timetable.
|
ISchedulerTimeTable |
copy()
Performs a deep copy of the time table.
|
Date |
getStartTime()
Get the starting date for the timetable.
|
Date |
getStopTime()
Get the ending date for the timetable.
|
ISchedulerTimeList |
getTable()
Deprecated.
since KM5.0SP6
|
ISchedulerTime |
getTime(Date date)
Returns a time object that matches the specific date.
|
boolean |
isInTable(Date date)
Test, if a given date is in the timetable.
|
ISchedulerTime |
removeFromTable(ISchedulerTime time)
Removes the specified time from the times of the timetable.
|
void |
setStartTime(Date start)
Set the starting date for the timetable.
|
void |
setStopTime(Date stop)
Set the ending date for the timetable.
|
void |
setTable(ISchedulerTime time)
Deprecated.
since KM5.0SP6
|
void |
setTable(ISchedulerTimeList timelist)
Deprecated.
since KM5.0SP6
|
int |
size()
Returns the size of this table.
|
ISchedulerTime[] |
toArray()
Converts the content of this time table to an array.
|
boolean isInTable(Date date)
date
- the Date
to check.boolean
true
if the date is in the
timetable, false
if it's not.ISchedulerTime getTime(Date date)
date
- the specific dateDate getStartTime()
Date
with the starting point of the timetable
or null
if not defined.void setStartTime(Date start) throws WcmException
start
- a Date
with the starting point for the
timetable or null
if not start time defined.WcmException
- exceptionDate getStopTime()
Date
with the ending point of the timetable.
or null
if not defined.void setStopTime(Date stop) throws WcmException
stop
- a Date
with the ending point for the
timetable or null
if not stop time defined.WcmException
- exceptionISchedulerTimeList getTable()
ISchedulerTimeList
with the valid times of this
table for the scheduler.void setTable(ISchedulerTimeList timelist) throws WcmException
timelist
- a ISchedulerTimeList
with the valid times
for the scheduler.WcmException
- exceptionvoid setTable(ISchedulerTime time) throws WcmException
time
- a ISchedulerTime
with the one time
for the scheduler.WcmException
- exceptionvoid addToTable(ISchedulerTime time) throws WcmException
time
- a ISchedulerTime
with the one time
for the scheduler to add.WcmException
- exceptionISchedulerTime removeFromTable(ISchedulerTime time) throws WcmException
time
- the specified time for a scheduler to be removedWcmException
- exceptionISchedulerTime[] toArray()
int size()
ISchedulerTimeTable copy()
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