com.inet.report.schedule
Interface ExecutionTimeProvider

All Known Implementing Classes:

DailyExecution, MonthlyExecution, OneDayExecution, ScheduleExecution, WeeklyExecution

public interface ExecutionTimeProvider

This interface defines what functionality a ScheduleExecution object must offer.

• The core of the object is the function getNextExecutionTime. This function is to return an java.util.Date object defining the exact point in time at which the task is to be executed next.
• Otherwise, the start date and the end date of the task must be settable and gettable. The start date, which must exist for an execution time object to be allowed, defines the day the execution of a task becomes possible, and the end date, if one exists, defines the last day a task may be executed.

Since:

6.0

See Also:

OneDayExecution, DailyExecution, WeeklyExecution, MonthlyExecution, ScheduleExecutionFactory, ScheduleExecution

Method Summary

java.util.Date	getEndDate() Returns the end date for this execution time provider - that is, the last point in time this task is allowed to be executed.
int	getLoopCount() Get the amount of executions after this task is stopped.
java.util.Date	getNextExecutionTime() The core of the object - must return the next point in time the task is to be executed.
java.util.Date	getStartDate() Returns the start date (NOT to be mistaken for the point in time - the only thing that counts in the date object is the actual day - setting a Date object with time information will cause the time information to be ignored.) for this execution time provider - that is, the first day this task is allowed to be executed.
void	setEndDate(java.util.Date date) Sets the end date for this execution time provider - that is, the last point in time this task is allowed to be executed.
void	setLoopCount(int loopCount) Set after how many executions this task should stop.
void	setStartDate(java.util.Date date) Sets the start date for this execution time provider - that is, the first day this task is allowed to be executed (NOT to be mistaken for the point in time - the only thing that counts in the date object is the actual day - setting a Date object with time information will cause the time information to be ignored.)

Method Detail

getNextExecutionTime

java.util.Date getNextExecutionTime()

The core of the object - must return the next point in time the task is to be executed. If there is no future execution time, this will return null.

Returns:

The next point in time the task is to be executed, or null if there is no future time of execution.

setStartDate

void setStartDate(java.util.Date date)
                  throws ScheduleException

Sets the start date for this execution time provider - that is, the first day this task is allowed to be executed (NOT to be mistaken for the point in time - the only thing that counts in the date object is the actual day - setting a Date object with time information will cause the time information to be ignored.)

Parameters:

date - The start date for this execution time provider. May not be null.

Throws:

ScheduleException - If date is null

getStartDate

java.util.Date getStartDate()

Returns the start date (NOT to be mistaken for the point in time - the only thing that counts in the date object is the actual day - setting a Date object with time information will cause the time information to be ignored.) for this execution time provider - that is, the first day this task is allowed to be executed.

Returns:

The start date for this execution time provider.

setEndDate

void setEndDate(java.util.Date date)

Sets the end date for this execution time provider - that is, the last point in time this task is allowed to be executed. If the end date is null, then there is no such "last point in time allowed".

Parameters:

date - The end date for this execution time provider. If null, end date is set to non-existent.

getEndDate

java.util.Date getEndDate()

Returns the end date for this execution time provider - that is, the last point in time this task is allowed to be executed. If the end date is null, then there is no such "last point in time allowed".

Returns:

The end date for this execution time provider.

setLoopCount

void setLoopCount(int loopCount)

Set after how many executions this task should stop.

Parameters:

loopCount - after how many executions it should stop, use -1 for never, 0 means it will not be scheduled at all. When 0, getNextExecutionTime() will always return null.

Since:

12.0

getLoopCount

int getLoopCount()

Get the amount of executions after this task is stopped.

Returns:

the amount, 0=it is currently stopped (will not be executed any longer), -1 = it is never stopped by this mechanism

Since:

12.0