org.openmrs.api.handler

Class BaseRetireHandler

java.lang.Object

org.openmrs.api.handler.BaseRetireHandler

All Implemented Interfaces:

RequiredDataHandler<Retireable>, RetireHandler<Retireable>

@Handler(supports=Retireable.class)
public class BaseRetireHandler
extends Object
implements RetireHandler<Retireable>

This is the default class for all retire* 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 retire* method. If it is a retire* method, this class is called to handle setting the Retireable.getRetired(), Retireable.setRetireReason(String), Retireable.setRetiredBy(User), and Retireable.setDateRetired(Date).

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

This class will only set the retiredBy and dateRetired attributes if retired is set to false. If retired is set to true, it is assumed that this object is in a list of things that is getting retired but that it itself was previously retired. The workaround to this is that if the retired bit is true OR the retiredBy is null, the retiredBy, dateRetired, and retireReason will be set.

Since:

1.5

See Also:

RequiredDataAdvice

Constructor Summary

Constructors

Constructor and Description
BaseRetireHandler()

Method Summary

Modifier and Type	Method and Description
void	handle(Retireable retireableObject, User retiringUser, Date retireDate, String retireReason) This method sets "retired" to true, the retired reason, and the retiredBy/dateRetired (if those are null).

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRetireHandler

public BaseRetireHandler()

Method Detail

handle

public void handle(Retireable retireableObject,
                   User retiringUser,
                   Date retireDate,
                   String retireReason)

This method sets "retired" to true, the retired reason, and the retiredBy/dateRetired (if those are null).

Specified by:

handle in interface RequiredDataHandler<Retireable>

Specified by:

handle in interface RetireHandler<Retireable>

Parameters:

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

retiringUser - the currently authenticated User

retireDate - the current Date

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

See Also:

Should set the retired bit Should set the retireReason Should set retired by Should not set retired by if non null Should set dateRetired Should not set dateRetired if non null Should not set the retireReason if already voided Should set retiredBy even if retired bit is set but retiredBy is null