org.openmrs.api.handler

Class BaseUnvoidHandler

java.lang.Object

org.openmrs.api.handler.BaseUnvoidHandler

All Implemented Interfaces:

RequiredDataHandler<Voidable>, UnvoidHandler<Voidable>

@Handler(supports=Voidable.class,
         order=10)
public class BaseUnvoidHandler
extends Object
implements UnvoidHandler<Voidable>

This is the super interface for all unvoid* actions that take place on all services. The RequiredDataAdvice class uses AOP around each method in every service to check to see if its a unvoid* method. If it is a unvoid* method, this class is called to handle setting the Voidable.getVoided(), Voidable.setVoidReason(String), Voidable.setVoidedBy(User), and Voidable.setDateVoided(Date) all to null.

Child collections on this Voidable that are themselves a Voidable are looped over and also unvoided by the RequiredDataAdvice class.

Since:

1.5

See Also:

RequiredDataAdvice, VoidHandler

Constructor Summary

Constructors

Constructor and Description
BaseUnvoidHandler()

Method Summary

Modifier and Type	Method and Description
void	handle(Voidable voidableObject, User voidingUser, Date origParentVoidedDate, String unused) Called around every unvoid* method to set everything to null.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseUnvoidHandler

public BaseUnvoidHandler()

Method Detail

handle

public void handle(Voidable voidableObject,
                   User voidingUser,
                   Date origParentVoidedDate,
                   String unused)

Called around every unvoid* method to set everything to null.

Specified by:

handle in interface RequiredDataHandler<Voidable>

Specified by:

handle in interface UnvoidHandler<Voidable>

Parameters:

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

voidingUser - the currently authenticated User

origParentVoidedDate - the current Date

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

See Also:

Should unset the voided bit Should unset the voider Should unset the dateVoided Should unset the voidReason Should only act on already voided objects Should not act on objects with a different dateVoided