org.openmrs.api.db

Interface NoteDAO

All Known Implementing Classes:

HibernateNoteDAO

public interface NoteDAO

Note-related database functions

Version:

1.0

Method Summary

Modifier and Type	Method and Description
void	createNote(Note note) Creates a new note record
void	deleteNote(Note note) TODO: Couldn't find a voidNote method Delete note from database.
Note	getNote(Integer noteId) Get note by internal identifier
List<Note>	getNotes() Get all notes
void	updateNote(Note note) Update note
Note	voidNote(Note note, String reason)

Method Detail

getNotes

List<Note> getNotes()
             throws DAOException

Get all notes

Returns:

List<Note> object with all Notes

Throws:

DAOException

createNote

void createNote(Note note)
         throws DAOException

Creates a new note record

Parameters:

note - to be created

Throws:

DAOException

getNote

Note getNote(Integer noteId)
      throws DAOException

Get note by internal identifier

Parameters:

noteId - Internal integer identifier for requested Note

Returns:

Note with given internal identifier

Throws:

DAOException

updateNote

void updateNote(Note note)
         throws DAOException

Update note

Parameters:

note - Note to be updated

Throws:

DAOException

deleteNote

void deleteNote(Note note)
         throws DAOException

TODO: Couldn't find a voidNote method Delete note from database. This should not be called except for testing and administration purposes. Use the void method instead.

Parameters:

note - Note to be deleted

Throws:

DAOException

voidNote

Note voidNote(Note note,
              String reason)
       throws APIException

Parameters:

note - Note to be voided

reason - Reason for having Note void

Throws:

APIException