org.openmrs.api.handler

Class VisitVoidHandler

java.lang.Object

org.openmrs.api.handler.VisitVoidHandler

All Implemented Interfaces:

RequiredDataHandler<Visit>, VoidHandler<Visit>

@Handler(supports=Visit.class)
public class VisitVoidHandler
extends Object
implements VoidHandler<Visit>

This class sets the void attributes on the given Visit object when a void* method is called with this class. This differs from the BaseVoidHandler because voiding the Visit object implies voiding encounters.

Since:

1.9

See Also:

RequiredDataAdvice, VoidHandler

Constructor Summary

Constructors

Constructor and Description
VisitVoidHandler()

Method Summary

Modifier and Type	Method and Description
void	handle(Visit voidableObject, 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

VisitVoidHandler

public VisitVoidHandler()

Method Detail

handle

public void handle(Visit voidableObject,
                   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<Visit>

Specified by:

handle in interface VoidHandler<Visit>

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)