org.openmrs.api.handler

Interface RequiredDataHandler<O extends OpenmrsObject>

All Known Subinterfaces:

RetireHandler<R>, SaveHandler<O>, UnretireHandler<R>, UnvoidHandler<V>, VoidHandler<V>

All Known Implementing Classes:

BaseRetireHandler, BaseUnretireHandler, BaseUnvoidHandler, BaseVoidHandler, ConceptNameSaveHandler, ConceptProposalHandler, ConceptReferenceTermSaveHandler, ConceptSaveHandler, EncounterSaveHandler, OpenmrsMetadataSaveHandler, OpenmrsObjectSaveHandler, OrderSaveHandler, PatientDataUnvoidHandler, PatientDataVoidHandler, PatientSaveHandler, PersonNameSaveHandler, PersonSaveHandler, PersonUnvoidHandler, PersonVoidHandler, RequireVoidReasonSaveHandler, RequireVoidReasonVoidHandler, RetireSaveHandler, UserSaveHandler, VisitUnvoidHandler, VisitVoidHandler, VoidSaveHandler

public interface RequiredDataHandler<O extends OpenmrsObject>

This is the super interface for all save*, void*, and retire* actions that take place on all services. The RequiredDataAdvice uses AOP around each method to call all handlers that a certain interface. Having this superinterface makes it easier to have one method for this.

Since:

1.5

See Also:

RequiredDataAdvice#recursivelyHandle(Class, OpenmrsObject, User, Date, String), RequiredDataAdvice, SaveHandler, VoidHandler, RetireHandler

Method Summary

Modifier and Type	Method and Description
void	handle(O openmrsObject, User currentUser, java.util.Date currentDate, java.lang.String other) This method is called to when the required data needs to be set.

Method Detail

handle

void handle(O openmrsObject,
            User currentUser,
            java.util.Date currentDate,
            java.lang.String other)

This method is called to when the required data needs to be set.

Parameters:

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

currentUser - the currently authenticated User

currentDate - the current Date

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