org.openmrs.api.handler

Class ExistingVisitAssignmentHandler

java.lang.Object

org.openmrs.api.handler.BaseEncounterVisitHandler

org.openmrs.api.handler.ExistingVisitAssignmentHandler

All Implemented Interfaces:

EncounterVisitHandler

Direct Known Subclasses:

ExistingOrNewVisitAssignmentHandler

@Handler
public class ExistingVisitAssignmentHandler
extends BaseEncounterVisitHandler

This handler assigns an encounter to an existing visit, where appropriate, but will never create a new visit.

See Also:

EncounterVisitHandler

Constructor Summary

Constructors

Constructor and Description
ExistingVisitAssignmentHandler()

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)

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

ExistingVisitAssignmentHandler

public ExistingVisitAssignmentHandler()

Method Detail

getDisplayName

public String getDisplayName(Locale locale)

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:

EncounterVisitHandler.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.

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 not assign visit if no match found Should not assign visit which stopped before encounter date