org.openmrs.api.handler

Class RequireVoidReasonVoidHandler

java.lang.Object

org.openmrs.api.handler.RequireVoidReasonVoidHandler

All Implemented Interfaces:

RequiredDataHandler<Voidable>, VoidHandler<Voidable>

@Handler(supports={Patient.class,Encounter.class,Obs.class,Cohort.class,Order.class},
         order=1)
public class RequireVoidReasonVoidHandler
extends Object
implements VoidHandler<Voidable>

This class ensures that the voidReason is non-null for supported object types

Since:

1.5

See Also:

RequiredDataAdvice, UnvoidHandler

Constructor Summary

Constructors

Constructor and Description
RequireVoidReasonVoidHandler()

Method Summary

Modifier and Type

Method and Description

void

handle(Voidable voidableObject, User voidingUser, Date voidedDate, String voidReason) Validates that the voidReason is non-null and non-empty for supported objects Should throw IllegalArgumentException if Patient voidReason is null Should throw IllegalArgumentException if Encounter voidReason is empty Should throw IllegalArgumentException if Obs voidReason is blank Should not throw Exception if voidReason is not blank Should not throw Exception if voidReason is null for unsupported types

Methods inherited from class java.lang.Object

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

Constructor Detail

RequireVoidReasonVoidHandler

public RequireVoidReasonVoidHandler()

Method Detail

handle

public void handle(Voidable voidableObject,
                   User voidingUser,
                   Date voidedDate,
                   String voidReason)

Validates that the voidReason is non-null and non-empty for supported objects Should throw IllegalArgumentException if Patient voidReason is null Should throw IllegalArgumentException if Encounter voidReason is empty Should throw IllegalArgumentException if Obs voidReason is blank Should not throw Exception if voidReason is not blank Should not throw Exception if voidReason is null for unsupported types

Specified by:

handle in interface RequiredDataHandler<Voidable>

Specified by:

handle in interface VoidHandler<Voidable>

Parameters:

voidableObject - 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:

RequiredDataHandler.handle(org.openmrs.OpenmrsObject, org.openmrs.User, java.util.Date, java.lang.String)