org.openmrs.api.handler

Class AuditableSaveHandler

java.lang.Object

org.openmrs.api.handler.AuditableSaveHandler

All Implemented Interfaces:

RequiredDataHandler<Auditable>, SaveHandler<Auditable>

@Handler(supports=Auditable.class)
public class AuditableSaveHandler
extends Object
implements SaveHandler<Auditable>

This class deals with any object that implements Auditable. When an Auditable is saved (via a save* method in a service), this handler is automatically called by the RequiredDataAdvice AOP class.

This sets the changedBy and dateChanged on the object if it has been saved previously (aka, it has an id).

Since:

1.5

See Also:

RequiredDataHandler

Constructor Summary

Constructors

Constructor and Description
AuditableSaveHandler()

Method Summary

Modifier and Type	Method and Description
void	handle(Auditable auditable, User currentUser, Date currentDate, String reason) This sets the changedBy and dateChanged on the object if it has been saved already (aka, it has an id).

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditableSaveHandler

public AuditableSaveHandler()

Method Detail

handle

public void handle(Auditable auditable,
                   User currentUser,
                   Date currentDate,
                   String reason)

This sets the changedBy and dateChanged on the object if it has been saved already (aka, it has an id).

Specified by:

handle in interface RequiredDataHandler<Auditable>

Specified by:

handle in interface SaveHandler<Auditable>

Parameters:

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

currentUser - the user who is saving this object

currentDate - the datetime this object is being saved

reason - (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)

Should:

set creator if null, not set creator if non null, set dateCreated if null, not set dateCreated if non null