org.opennms.core.tasks

Interface Task

All Known Implementing Classes:

AbstractTask, AsyncTask, BatchTask, ContainerTask, Phase, Phase.PhaseMethod, SequenceTask, SyncTask

public interface Task

BaseTask

Version:

$Id: $

Author:

brozow

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Task.State

Method Summary

Modifier and Type	Method and Description
TaskCoordinator	getCoordinator() getCoordinator
TaskMonitor	getMonitor() getMonitor
void	schedule() This is called to add the task to the queue of tasks that can be considered to be runnable
void	waitFor() Wait for this task to complete.
boolean	waitFor(long timeout, TimeUnit unit) Wait for this task to complete or until a timeout occurs.

Method Detail

getCoordinator

TaskCoordinator getCoordinator()

getCoordinator

Returns:

a TaskCoordinator object.

getMonitor

TaskMonitor getMonitor()

getMonitor

Returns:

a TaskMonitor object.

schedule

void schedule()

This is called to add the task to the queue of tasks that can be considered to be runnable

waitFor

void waitFor()
      throws InterruptedException,
             ExecutionException

Wait for this task to complete. The current thread will block until this task has been completed.

Throws:

InterruptedException - if any.

ExecutionException - if any.

waitFor

boolean waitFor(long timeout,
                TimeUnit unit)
         throws InterruptedException

Wait for this task to complete or until a timeout occurs. If the timeout elapses, then false is returned.

Parameters:

timeout - a long.

unit - a TimeUnit object.

Throws:

InterruptedException - if any.