org.openmrs.api.handler

Class PatientDataVoidHandler

java.lang.Object

org.openmrs.api.handler.PatientDataVoidHandler

All Implemented Interfaces:

RequiredDataHandler<Patient>, VoidHandler<Patient>

@Handler(supports=Patient.class)
public class PatientDataVoidHandler
extends Object
implements VoidHandler<Patient>

This class deals with Patient objects when they are voided via a void* method in an Openmrs Service. This handler is automatically called by the RequiredDataAdvice AOP class.
The handler voids all the encounters(including their associated observations) and orders associated with the specified patient object

Since:

1.9

See Also:

RequiredDataHandler, VoidHandler, Patient

Constructor Summary

Constructors

Constructor and Description
PatientDataVoidHandler()

Method Summary

Modifier and Type	Method and Description
void	handle(Patient patient, User voidingUser, Date voidedDate, String voidReason) Implementing classes should set all void attributes to the given parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

PatientDataVoidHandler

public PatientDataVoidHandler()

Method Detail

handle

public void handle(Patient patient,
                   User voidingUser,
                   Date voidedDate,
                   String voidReason)

Description copied from interface: VoidHandler

Implementing classes should set all void attributes to the given parameters.

Specified by:

handle in interface RequiredDataHandler<Patient>

Specified by:

handle in interface VoidHandler<Patient>

Parameters:

patient - an OpenmrsObject that needs to have some required data set

voidingUser - the currently authenticated User

voidedDate - the current Date

voidReason - (optional) would be the second argument in the save/void/unvoid/etc method, if exists

See Also:

Should void the orders encounters and observations associated with the patient