org.openmrs.api.db.hibernate

Class HibernateNoteDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernateNoteDAO

All Implemented Interfaces:

NoteDAO

public class HibernateNoteDAO
extends Object
implements NoteDAO

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
HibernateNoteDAO()

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 id) Get note by internal identifier
List<Note>	getNotes() Get all notes
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory) Set session factory
void	updateNote(Note note) Update note
Note	voidNote(Note note, String reason)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

HibernateNoteDAO

public HibernateNoteDAO()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Set session factory

Parameters:

sessionFactory -

getNotes

public List<Note> getNotes()

Description copied from interface: NoteDAO

Get all notes

Specified by:

getNotes in interface NoteDAO

Returns:

List<Note> object of all Notes from the database

getNote

public Note getNote(Integer id)

Description copied from interface: NoteDAO

Get note by internal identifier

Specified by:

getNote in interface NoteDAO

Parameters:

id - Internal integer identifier for requested Note

Returns:

Note with given internal identifier

See Also:

NoteDAO.getNote(Integer)

createNote

public void createNote(Note note)

Description copied from interface: NoteDAO

Creates a new note record

Specified by:

createNote in interface NoteDAO

Parameters:

note - to be created

updateNote

public void updateNote(Note note)

Description copied from interface: NoteDAO

Update note

Specified by:

updateNote in interface NoteDAO

Parameters:

note - Note to be updated

deleteNote

public void deleteNote(Note note)
                throws DAOException

Description copied from interface: NoteDAO

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.

Specified by:

deleteNote in interface NoteDAO

Parameters:

note - Note to be deleted

Throws:

DAOException

voidNote

public Note voidNote(Note note,
                     String reason)
              throws APIException

Specified by:

voidNote in interface NoteDAO

Parameters:

note - Note to be voided

reason - Reason for having Note void

Throws:

APIException

See Also:

NoteDAO.voidNote(org.openmrs.notification.Note, java.lang.String)