org.openmrs.api.handler

Class BaseUnretireHandler

java.lang.Object

org.openmrs.api.handler.BaseUnretireHandler

All Implemented Interfaces:

RequiredDataHandler<Retireable>, UnretireHandler<Retireable>

@Handler(supports=Retireable.class)
public class BaseUnretireHandler
extends Object
implements UnretireHandler<Retireable>

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

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

Since:

1.5

See Also:

RequiredDataAdvice, RetireHandler

Constructor Summary

Constructors

Constructor and Description
BaseUnretireHandler()

Method Summary

Modifier and Type	Method and Description
void	handle(Retireable retireableObject, User retiringUser, Date origParentRetiredDate, String unused) Called around every unretire* method to set Retireable attributes to null.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseUnretireHandler

public BaseUnretireHandler()

Method Detail

handle

public void handle(Retireable retireableObject,
                   User retiringUser,
                   Date origParentRetiredDate,
                   String unused)

Called around every unretire* method to set Retireable attributes to null.

Specified by:

handle in interface RequiredDataHandler<Retireable>

Specified by:

handle in interface UnretireHandler<Retireable>

Parameters:

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

retiringUser - the currently authenticated User

origParentRetiredDate - the current Date

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

See Also:

Should unset the retired bit Should unset the retirer Should unset the date retired Should unset the retire reason Should not act on already unretired objects Should not act on retired objects with a different dateRetired