org.openmrs.api.handler

Class ExistingOrNewVisitAssignmentHandler

java.lang.Object

org.openmrs.api.handler.BaseEncounterVisitHandler

org.openmrs.api.handler.ExistingVisitAssignmentHandler

org.openmrs.api.handler.ExistingOrNewVisitAssignmentHandler

All Implemented Interfaces:

GlobalPropertyListener, EncounterVisitHandler

public class ExistingOrNewVisitAssignmentHandler
extends ExistingVisitAssignmentHandler
implements GlobalPropertyListener

This handler assigns an encounter to an existing visit, where appropriate, or creates a new one.

See Also:

EncounterVisitHandler

Constructor Summary

Constructors

Constructor and Description
ExistingOrNewVisitAssignmentHandler()

Method Summary

Modifier and Type	Method and Description
void	beforeCreateEncounter(Encounter encounter) Implementations of this method should look at the given encounter and choose whether or not it should be assigned to a Visit that is already open or if it should be part of a new visit.
String	getDisplayName(Locale locale)
void	globalPropertyChanged(GlobalProperty newValue) Called after a global property is created or updated
void	globalPropertyDeleted(String propertyName) Called after a global property is deleted
boolean	supportsPropertyName(String propertyName) Asks this listener whether it wants to be notified about the given property name

Methods inherited from class org.openmrs.api.handler.BaseEncounterVisitHandler

getDisplayName

Methods inherited from class java.lang.Object

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

Constructor Detail

ExistingOrNewVisitAssignmentHandler

public ExistingOrNewVisitAssignmentHandler()

Method Detail

getDisplayName

public String getDisplayName(Locale locale)

Specified by:

getDisplayName in interface EncounterVisitHandler

Overrides:

getDisplayName in class ExistingVisitAssignmentHandler

Parameters:

locale - optional locale to specify. If none is passed, Context.getLocale() should be used

Returns:

a displayable string so that users can pick between different assignment handlers

See Also:

ExistingVisitAssignmentHandler.getDisplayName(java.util.Locale)

beforeCreateEncounter

public void beforeCreateEncounter(Encounter encounter)

Description copied from interface: EncounterVisitHandler

Implementations of this method should look at the given encounter and choose whether or not it should be assigned to a Visit that is already open or if it should be part of a new visit.

The decision of what to do is up to the handler, but it should call Encounter.setVisit(Visit) with the outcome. The visit assigned to the encounter will be persisted to the database after this method is returned, so the handler is not required to save it.

Specified by:

beforeCreateEncounter in interface EncounterVisitHandler

Overrides:

beforeCreateEncounter in class ExistingVisitAssignmentHandler

Parameters:

encounter - the new unsaved encounter in question of whether to assign to a visit

See Also:

Should assign existing visit if match found Should assign new visit if no match found Should resolve encounter and visit type uuids as global property values

supportsPropertyName

public boolean supportsPropertyName(String propertyName)

Description copied from interface: GlobalPropertyListener

Asks this listener whether it wants to be notified about the given property name

Specified by:

supportsPropertyName in interface GlobalPropertyListener

Returns:

whether this listener wants its action methods to be notified of properties with the given name

globalPropertyChanged

public void globalPropertyChanged(GlobalProperty newValue)

Description copied from interface: GlobalPropertyListener

Called after a global property is created or updated

Specified by:

globalPropertyChanged in interface GlobalPropertyListener

Parameters:

newValue - the new value of the property that was just saved

globalPropertyDeleted

public void globalPropertyDeleted(String propertyName)

Description copied from interface: GlobalPropertyListener

Called after a global property is deleted

Specified by:

globalPropertyDeleted in interface GlobalPropertyListener

Parameters:

propertyName - the name of the property that was just deleted