org.openmrs.api.impl

Class MedicationDispenseServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.MedicationDispenseServiceImpl

All Implemented Interfaces:

MedicationDispenseService, OpenmrsService

@Transactional
public class MedicationDispenseServiceImpl
extends BaseOpenmrsService
implements MedicationDispenseService

This class implements the MedicationDispenseService interface It defines the API for interacting with MedicationDispense objects.

Since:

2.6.0

Constructor Summary

Constructors

Constructor and Description
MedicationDispenseServiceImpl()

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
MedicationDispenseDAO	getMedicationDispenseDAO()
void	purgeMedicationDispense(MedicationDispense medicationDispense) Completely remove a MedicationDispense from the database.
MedicationDispense	saveMedicationDispense(MedicationDispense medicationDispense) Saves a MedicationDispense
void	setMedicationDispenseDAO(MedicationDispenseDAO conditionDAO)
MedicationDispense	unvoidMedicationDispense(MedicationDispense medicationDispense) Un-void a previously voided MedicationDispense
MedicationDispense	voidMedicationDispense(MedicationDispense medicationDispense, String reason) Voids a MedicationDispense

Methods inherited from class org.openmrs.api.impl.BaseOpenmrsService

onShutdown, onStartup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Constructor Detail

MedicationDispenseServiceImpl

public MedicationDispenseServiceImpl()

Method Detail

setMedicationDispenseDAO

public void setMedicationDispenseDAO(MedicationDispenseDAO conditionDAO)

getMedicationDispenseDAO

public MedicationDispenseDAO getMedicationDispenseDAO()

getMedicationDispense

@Transactional(readOnly=true)
public MedicationDispense getMedicationDispense(Integer medicationDispenseId)

Description copied from interface: MedicationDispenseService

Gets a MedicationDispense by id

Specified by:

getMedicationDispense in interface MedicationDispenseService

Parameters:

medicationDispenseId - the id of the MedicationDispense to retrieve

Returns:

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

getMedicationDispenseByUuid

@Transactional(readOnly=true)
public MedicationDispense getMedicationDispenseByUuid(String uuid)

Description copied from interface: MedicationDispenseService

Gets a MedicationDispense based on the uuid

Specified by:

getMedicationDispenseByUuid in interface MedicationDispenseService

Parameters:

uuid - - uuid of the MedicationDispense to be returned

Returns:

the MedicationDispense

getMedicationDispenseByCriteria

@Transactional(readOnly=true)
public List<MedicationDispense> getMedicationDispenseByCriteria(MedicationDispenseCriteria criteria)

Description copied from interface: MedicationDispenseService

Gets all MedicationDispense results that match the given criteria

Specified by:

getMedicationDispenseByCriteria in interface MedicationDispenseService

Parameters:

criteria - - the criteria for the returned MedicationDispense results

Returns:

a list of MedicationDispenses

saveMedicationDispense

public MedicationDispense saveMedicationDispense(MedicationDispense medicationDispense)

Description copied from interface: MedicationDispenseService

Saves a MedicationDispense

Specified by:

saveMedicationDispense in interface MedicationDispenseService

Parameters:

medicationDispense - - the MedicationDispense to be saved

voidMedicationDispense

public MedicationDispense voidMedicationDispense(MedicationDispense medicationDispense,
                                                 String reason)

Description copied from interface: MedicationDispenseService

Voids a MedicationDispense

Specified by:

voidMedicationDispense in interface MedicationDispenseService

Parameters:

medicationDispense - the MedicationDispense to be voided

reason - the reason for voiding the MedicationDispense

unvoidMedicationDispense

public MedicationDispense unvoidMedicationDispense(MedicationDispense medicationDispense)

Description copied from interface: MedicationDispenseService

Un-void a previously voided MedicationDispense

Specified by:

unvoidMedicationDispense in interface MedicationDispenseService

Parameters:

medicationDispense - MedicationDispense to un-void

purgeMedicationDispense

public void purgeMedicationDispense(MedicationDispense medicationDispense)
                             throws APIException

Description copied from interface: MedicationDispenseService

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.

Specified by:

purgeMedicationDispense in interface MedicationDispenseService

Parameters:

medicationDispense - the MedicationDispense to be purged

Throws:

APIException