com.sssw.fw.task.api
Interface EbiScheduledTask

All Superinterfaces:

EbiElement, EbiTask, Serializable

public interface EbiScheduledTask

extends EbiTask

Interface that defines the behavior for a scheduled task. This kind of task is to be executed once for each of the dates from the date list that is set up for the task.

Field Summary

static String

TASK_KIND_SCHEDULED The constant for a scheduled task.

Fields inherited from interface com.sssw.fw.task.api.EbiTask

TASK_OBJECT_ID

Method Summary

Timestamp	getDate(int dateIndex) Given an index into the date list, gets the date pointed to by the index.
int	getDateIndex() Gets the index pointing to the current date in the date list.
Timestamp[]	getDates() Gets the date list specified for this task.
Timestamp	gotoNextDate() Advances in the date list to the next date.
boolean	hasMoreDates() Determines whether there is at least one more date in the date list.
void	setDates(Timestamp[] dates) Sets up the date list.

Methods implemented from interface com.sssw.fw.task.api.EbiTask

doTask, enable, execute, fromXML, getContext, getDescription, getLaunchTime, getName, getSinceLast, getTaskType, getTimesRan, getUserObject, isEnabled, isOfType, isStarted, setContext, setDescription, setLaunchTime, setName, setSinceLast, setTaskType, setTimesRan, setUserObject, start, stop

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

TASK_KIND_SCHEDULED

public static final String TASK_KIND_SCHEDULED

The constant for a scheduled task.

Method Detail

getDate

public Timestamp getDate(int dateIndex)

Given an index into the date list, gets the date pointed to by the index.

Parameters:

dateIndex - The index.

Returns:

The date; null if not found.

getDateIndex

public int getDateIndex()

Gets the index pointing to the current date in the date list.

Returns:

The index pointing to the current date in the date list.

getDates

public Timestamp[] getDates()

Gets the date list specified for this task.

Returns:

The date list specified for this task.

gotoNextDate

public Timestamp gotoNextDate()

Advances in the date list to the next date.

Returns:

The next date in the date list or null if at the end of list.

hasMoreDates

public boolean hasMoreDates()

Determines whether there is at least one more date in the date list.

Returns:

True if there is at least one more date in the date list, false if the end of list has been reached.

setDates

public void setDates(Timestamp[] dates)

Sets up the date list.

Parameters:

dates - The date list.