org.openmrs.scheduler.db

Interface SchedulerDAO

All Known Implementing Classes:

HibernateSchedulerDAO

public interface SchedulerDAO

Scheduler-related database methods.

Version:

1.0

Method Summary

Modifier and Type	Method and Description
void	createTask(TaskDefinition taskDefinition) Creates a new task.
void	deleteTask(java.lang.Integer taskId) Delete task from database.
void	deleteTask(TaskDefinition task) Delete task from database.
Schedule	getSchedule(java.lang.Integer scheduleId) Get schedule by internal identifier
TaskDefinition	getTask(java.lang.Integer taskId) Get task by internal identifier
TaskDefinition	getTaskByName(java.lang.String name) Get task by public name.
java.util.List<TaskDefinition>	getTasks() Find all tasks in the database
void	updateTask(TaskDefinition task) Update task

Method Detail

createTask

void createTask(TaskDefinition taskDefinition)
         throws DAOException

Creates a new task.

Parameters:

taskDefinition - task to be created

Throws:

DAOException

getTask

TaskDefinition getTask(java.lang.Integer taskId)
                throws DAOException

Get task by internal identifier

Parameters:

taskId - internal task identifier

Returns:

task with given internal identifier

Throws:

DAOException

updateTask

void updateTask(TaskDefinition task)
         throws DAOException

Update task

Parameters:

task - to be updated

Throws:

DAOException

getTasks

java.util.List<TaskDefinition> getTasks()
                                 throws DAOException

Find all tasks in the database

Returns:

List of all tasks

Throws:

DAOException

deleteTask

void deleteTask(TaskDefinition task)
         throws DAOException

Delete task from database.

Parameters:

task - task to be deleted

Throws:

DAOException

deleteTask

void deleteTask(java.lang.Integer taskId)
         throws DAOException

Delete task from database.

Parameters:

taskId - identifier of task to be deleted

Throws:

DAOException

getSchedule

Schedule getSchedule(java.lang.Integer scheduleId)
              throws DAOException

Get schedule by internal identifier

Parameters:

scheduleId - internal schedule identifier

Returns:

schedule with given internal identifier

Throws:

DAOException

getTaskByName

TaskDefinition getTaskByName(java.lang.String name)
                      throws DAOException

Get task by public name.

Parameters:

name - public task name

Returns:

task with given public name

Throws:

DAOException