fr.liglab.adele.icasa.service.scheduler

Interface TaskReference

public interface TaskReference

The reference to a task scheduled for one or more executions on the SchedulerService. TaskReference allows getting a report after each execution of the attached Task.

Author:

Chameleon Project Team

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(boolean interrupt) Cancels all non-running (and optionally interrupt currently-running) executions of this task and returns immediately.
long	getCancellationTime() Gets the cancellation time of this task if it has been canceled, -1 otherwise.
TaskExecutionReport[]	getExecutionReports() Gets the reports of all the completed executions of this task.
long	getRegistrationTime() Gets the time of registration of this task.
boolean	isCancelled() Gets true if this task has been canceled (using the cancel(boolean) method), false otherwise.

Method Detail

getRegistrationTime

long getRegistrationTime()

Gets the time of registration of this task. This time is not the time of the first execution.

Returns:

the time of registration of this task.

cancel

void cancel(boolean interrupt)

Cancels all non-running (and optionally interrupt currently-running) executions of this task and returns immediately.

Currently running executions of this task are interrupted (see Thread.interrupt()) if the interrupt parameter is set to true, otherwise they can continue until they terminate.

Calling this method has no effect if this task is already canceled (see isCancelled().

Parameters:

interrupt - true if the currently running executions of this task must be immediately interrupted, false otherwise.

See Also:

isCancelled()

isCancelled

boolean isCancelled()

Gets true if this task has been canceled (using the cancel(boolean) method), false otherwise.

Returns:

true if this task was canceled, false otherwise.

See Also:

cancel(boolean)

getCancellationTime

long getCancellationTime()

Gets the cancellation time of this task if it has been canceled, -1 otherwise.

Returns:

the cancellation time of this task if it has been canceled, -1 otherwise.

See Also:

isCancelled()

getExecutionReports

TaskExecutionReport[] getExecutionReports()

Gets the reports of all the completed executions of this task.

Returns:

the list of all the task executions of this task, or empty if no execution of this task has completed yet.