org.openmrs.notification

Interface NoteService

All Known Implementing Classes:

NoteServiceImpl

public interface NoteService

The NoteService is concerned with creating/updating/voiding and getting a Note to/from the database Usage.

Method Summary

Modifier and Type	Method and Description
void	createNote(Note note) Creates a Note for a user.
Note	getNote(Integer noteId) Gets a note by internal primary key identifier
List<Note>	getNotes(User user) Get all Notes for a given user, Does not return voided notes.
void	updateNote(Note note) Save or update the given note in the database
Note	voidNote(Note note, String reason) Mark a note as voided.

Method Detail

getNotes

@Authorized(value="Get Notes")
List<Note> getNotes(User user)
                                            throws Exception

Get all Notes for a given user, Does not return voided notes.

Parameters:

user - the user to match on

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:

Exception

createNote

void createNote(Note note)
         throws Exception

Creates a Note for a user. Creates a Note for a person.

Parameters:

note - the Note being created

Throws:

Exception

getNote

Note getNote(Integer noteId)
      throws Exception

Gets a note by internal primary key identifier

Parameters:

noteId - the internal primary key identifier for a Note

Throws:

Exception

updateNote

void updateNote(Note note)
         throws Exception

Save or update the given note in the database

Parameters:

note - note being updated

Throws:

Exception

voidNote

@Authorized(value="Delete Notes")
Note voidNote(Note note,
                                                String reason)
                                         throws APIException

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

Parameters:

note - note being voided

reason - a reason for the the void action

Throws:

APIException

Expected Behavior:

Should void the Note and set the voidReason