org.openmrs.scheduler
Interface Task

All Known Implementing Classes:
AbstractTask, AlertReminderTask, CheckInternetConnectivityTask, ConceptWordUpdateTask, GenerateDataExportTask, HelloWorldTask, ProcessHL7InQueueTask, SendEmailTask, StatefulTask, TaskThreadedInitializationWrapper, TestTask

public interface Task


Method Summary
 void execute()
          Executes the task defined in the task definition.
 TaskDefinition getTaskDefinition()
          Returns the task definition associated with this task.
 void initialize(TaskDefinition definition)
          Initializes the task and sets the task definition.
 boolean isExecuting()
          Returns true if the task is currently in its execute() method.
 void shutdown()
          Callback method used to clean up resources used during the tasks execution.
 

Method Detail

execute

void execute()
Executes the task defined in the task definition.


initialize

void initialize(TaskDefinition definition)
Initializes the task and sets the task definition.

Parameters:
definition -

getTaskDefinition

TaskDefinition getTaskDefinition()
Returns the task definition associated with this task.

Returns:
a task definition

isExecuting

boolean isExecuting()
Returns true if the task is currently in its execute() method.

Returns:
true if task is executing, false otherwise

shutdown

void shutdown()
Callback method used to clean up resources used during the tasks execution.


OpenMRS-1.7.x

Generated Apr 27 2012 10:06 PM. NOTE - these libraries are in active development and subject to change