com.sapportals.wcm.service.scheduler

Interface ISchedulerTimeTable

public interface ISchedulerTimeTable

Timetables for the scheduler.

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

See Also:

ISchedulerService, ISchedulerTime

Method Summary

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.

Method Detail

isInTable

boolean isInTable(Date date)

Test, if a given date is in the timetable.

Parameters:

date - the Date to check.

Returns:

a boolean true if the date is in the timetable, false if it's not.

getTime

ISchedulerTime getTime(Date date)

Returns a time object that matches the specific date.

Parameters:

date - the specific date

Returns:

a time object that matches the specific data.

getStartTime

Date getStartTime()

Get the starting date for the timetable.

Returns:

a Date with the starting point of the timetable or null if not defined.

setStartTime

void setStartTime(Date start)
                  throws WcmException

Set the starting date for the timetable.

Parameters:

start - a Date with the starting point for the timetable or null if not start time defined.

Throws:

WcmException

getStopTime

Date getStopTime()

Get the ending date for the timetable.

Returns:

a Date with the ending point of the timetable. or null if not defined.

setStopTime

void setStopTime(Date stop)
                 throws WcmException

Set the ending date for the timetable.

Parameters:

stop - a Date with the ending point for the timetable or null if not stop time defined.

Throws:

WcmException

getTable

ISchedulerTimeList getTable()

Deprecated. since KM5.0SP6

Get the times of the timetable.

Returns:

a ISchedulerTimeList with the valid times of this table for the scheduler.

setTable

void setTable(ISchedulerTimeList timelist)
              throws WcmException

Deprecated. since KM5.0SP6

Set the times of the timetable.

Parameters:

timelist - a ISchedulerTimeList with the valid times for the scheduler.

Throws:

WcmException

setTable

void setTable(ISchedulerTime time)
              throws WcmException

Deprecated. since KM5.0SP6

Set the times of the timetable to the given time.

Parameters:

time - a ISchedulerTime with the one time for the scheduler.

Throws:

WcmException

addToTable

void addToTable(ISchedulerTime time)
                throws WcmException

Add an time to the times of the timetable.

Parameters:

time - a ISchedulerTime with the one time for the scheduler to add.

Throws:

WcmException

removeFromTable

ISchedulerTime removeFromTable(ISchedulerTime time)
                               throws WcmException

Removes the specified time from the times of the timetable.

Parameters:

time - the specified time for a scheduler to be removed

Returns:

removed time for a scheduler

Throws:

WcmException

toArray

ISchedulerTime[] toArray()

Converts the content of this time table to an array.

Returns:

an array of scheudler times

size

int size()

Returns the size of this table.

Returns:

The number of scheudler times added to this table

copy

ISchedulerTimeTable copy()

Performs a deep copy of the time table.

Returns:

a new time table instance.

Access Rights

This class can be accessed from:

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