org.openmrs.api

Interface MedicationDispenseService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

MedicationDispenseServiceImpl

public interface MedicationDispenseService
extends OpenmrsService

This interface defines an API for interacting with MedicationDispense objects.

Since:

2.6.0

Method Summary

Modifier and Type	Method and Description
MedicationDispense	getMedicationDispense(Integer medicationDispenseId) Gets a MedicationDispense by id
List<MedicationDispense>	getMedicationDispenseByCriteria(MedicationDispenseCriteria criteria) Gets all MedicationDispense results that match the given criteria
MedicationDispense	getMedicationDispenseByUuid(String uuid) Gets a MedicationDispense based on the uuid
void	purgeMedicationDispense(MedicationDispense medicationDispense) Completely remove a MedicationDispense from the database.
MedicationDispense	saveMedicationDispense(MedicationDispense medicationDispense) Saves a MedicationDispense
MedicationDispense	unvoidMedicationDispense(MedicationDispense medicationDispense) Un-void a previously voided MedicationDispense
MedicationDispense	voidMedicationDispense(MedicationDispense medicationDispense, String reason) Voids a MedicationDispense

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

getMedicationDispense

@Authorized(value="Get Medication Dispense")
MedicationDispense getMedicationDispense(Integer medicationDispenseId)

Gets a MedicationDispense by id

Parameters:

medicationDispenseId - the id of the MedicationDispense to retrieve

Returns:

the MedicationDispense with the given id, or null if none exists

getMedicationDispenseByUuid

@Authorized(value="Get Medication Dispense")
MedicationDispense getMedicationDispenseByUuid(String uuid)

Gets a MedicationDispense based on the uuid

Parameters:

uuid - - uuid of the MedicationDispense to be returned

Returns:

the MedicationDispense

getMedicationDispenseByCriteria

@Authorized(value="Get Medication Dispense")
List<MedicationDispense> getMedicationDispenseByCriteria(MedicationDispenseCriteria criteria)

Gets all MedicationDispense results that match the given criteria

Parameters:

criteria - - the criteria for the returned MedicationDispense results

Returns:

a list of MedicationDispenses

saveMedicationDispense

@Authorized(value="Edit Medication Dispense")
MedicationDispense saveMedicationDispense(MedicationDispense medicationDispense)

Saves a MedicationDispense

Parameters:

medicationDispense - - the MedicationDispense to be saved

voidMedicationDispense

@Authorized(value="Edit Medication Dispense")
MedicationDispense voidMedicationDispense(MedicationDispense medicationDispense,
                                                                                        String reason)

Voids a MedicationDispense

Parameters:

medicationDispense - the MedicationDispense to be voided

reason - the reason for voiding the MedicationDispense

unvoidMedicationDispense

@Authorized(value="Edit Medication Dispense")
MedicationDispense unvoidMedicationDispense(MedicationDispense medicationDispense)

Un-void a previously voided MedicationDispense

Parameters:

medicationDispense - MedicationDispense to un-void

purgeMedicationDispense

@Authorized(value="Delete Medication Dispense")
void purgeMedicationDispense(MedicationDispense medicationDispense)

Completely remove a MedicationDispense from the database. This should typically not be called because we don't want to ever lose data. The data really should be voided and then it is not seen in interface any longer (see #voidMedicationDispense(MedicationDispense) for that one) If other data references this medicationDispense, an error will be thrown.

Parameters:

medicationDispense - the MedicationDispense to be purged