org.openmrs.notification.impl

Class NoteServiceImpl

java.lang.Object

org.openmrs.notification.impl.NoteServiceImpl

All Implemented Interfaces:

Serializable, NoteService

public class NoteServiceImpl
extends Object
implements NoteService, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NoteServiceImpl() Public constructor.

Method Summary

Modifier and Type	Method and Description
void	createNote(Note note) Creates a new note.
Note	getNote(Integer noteId) Get note by internal identifier
Collection<Note>	getNotes() Get all notes from the database.
List<Note>	getNotes(User user) Get notes by user.
void	setNoteDAO(NoteDAO dao)
void	updateNote(Note note) Update a note.
Note	voidNote(Note note, String reason) Mark a note as voided.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteServiceImpl

public NoteServiceImpl()

Public constructor.

Method Detail

setNoteDAO

public void setNoteDAO(NoteDAO dao)

getNotes

public Collection<Note> getNotes()
                          throws Exception

Get all notes from the database.

Returns:

Collection<Note> of all notes from the database

Throws:

Exception

createNote

public void createNote(Note note)
                throws Exception

Creates a new note.

Specified by:

createNote in interface NoteService

Parameters:

note - to be created

Throws:

APIException

Exception

getNote

public Note getNote(Integer noteId)
             throws Exception

Get note by internal identifier

Specified by:

getNote in interface NoteService

Parameters:

noteId - internal note identifier

Returns:

note with given internal identifier

Throws:

APIException

Exception

updateNote

public void updateNote(Note note)
                throws Exception

Update a note.

Specified by:

updateNote in interface NoteService

Parameters:

note - to be updated

Throws:

APIException

Exception

getNotes

public List<Note> getNotes(User user)
                    throws Exception

Get notes by user.

Specified by:

getNotes in interface NoteService

Parameters:

user -

Returns:

a List<Note> object containing all non-voided notes for the specified user Get all Notes for a given user, Does not return voided notes.

Throws:

APIException

Exception

voidNote

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

Description copied from interface: NoteService

Mark a note as voided. This functionally removes the Note from the system while keeping a semblance

Specified by:

voidNote in interface NoteService

Parameters:

note - Note to be voided

reason - Reason for having Note void

Throws:

APIException

See Also:

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