org.openmrs.api.handler

Interface SaveHandler<O extends OpenmrsObject>

All Superinterfaces:

RequiredDataHandler<O>

All Known Implementing Classes:

AuditableSaveHandler, ConceptNameSaveHandler, ConceptProposalHandler, ConceptSaveHandler, EncounterSaveHandler, OpenmrsMetadataSaveHandler, OpenmrsObjectSaveHandler, OrderSaveHandler, PatientSaveHandler, PersonNameSaveHandler, PersonSaveHandler, RequireVoidReasonSaveHandler, RetireSaveHandler, UserSaveHandler, VoidSaveHandler

public interface SaveHandler<O extends OpenmrsObject>
extends RequiredDataHandler<O>

This is the super interface for all save* actions that take place on all services. AOP is used around each method to see if its a save* method. If it is, then all handlers that implement this class (that also support the current object being saved) are called.

Since:

1.5

See Also:

RequiredDataAdvice, OpenmrsObjectSaveHandler, AuditableSaveHandler, ConceptNameSaveHandler

Method Summary

Modifier and Type	Method and Description
void	handle(O object, User creator, Date dateCreated, String other) This method is used by the implementing classes to set any required data that it needs to.

Method Detail

handle

void handle(O object,
            User creator,
            Date dateCreated,
            String other)

This method is used by the implementing classes to set any required data that it needs to.

Specified by:

handle in interface RequiredDataHandler<O extends OpenmrsObject>

Parameters:

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

creator - the user who is saving this object

dateCreated - the datetime this object is being saved

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

See Also:

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