org.openmrs.api.impl

Class VisitServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.VisitServiceImpl

All Implemented Interfaces:

OpenmrsService, VisitService

public class VisitServiceImpl
extends BaseOpenmrsService
implements VisitService

Default implementation of the VisitService. This class should not be used on its own. The current OpenMRS implementation should be fetched from the Context.

Since:

1.9

Constructor Summary

Constructors

Constructor and Description
VisitServiceImpl()

Method Summary

Modifier and Type	Method and Description
Visit	endVisit(Visit visit, java.util.Date stopDate) Sets the stopDate of a given visit.
java.util.List<Visit>	getActiveVisitsByPatient(Patient patient) Convenience method that delegates to getVisitsByPatient(patient, false, false)
java.util.List<VisitAttributeType>	getAllVisitAttributeTypes()
java.util.List<Visit>	getAllVisits() Gets all unvoided visits in the database.
java.util.List<VisitType>	getAllVisitTypes() Gets all visit types.
Visit	getVisit(java.lang.Integer visitId) Gets a visit by its visit id.
VisitAttribute	getVisitAttributeByUuid(java.lang.String uuid)
VisitAttributeType	getVisitAttributeType(java.lang.Integer id)
VisitAttributeType	getVisitAttributeTypeByUuid(java.lang.String uuid)
Visit	getVisitByUuid(java.lang.String uuid) Gets a visit by its UUID.
VisitDAO	getVisitDAO()
java.util.List<Visit>	getVisits(java.util.Collection<VisitType> visitTypes, java.util.Collection<Patient> patients, java.util.Collection<Location> locations, java.util.Collection<Concept> indications, java.util.Date minStartDatetime, java.util.Date maxStartDatetime, java.util.Date minEndDatetime, java.util.Date maxEndDatetime, java.util.Map<VisitAttributeType,java.lang.Object> attributeValues, boolean includeInactive, boolean includeVoided) Gets the visits matching the specified arguments
java.util.List<Visit>	getVisitsByPatient(Patient patient) Gets all unvoided visits for the specified patient
java.util.List<Visit>	getVisitsByPatient(Patient patient, boolean includeInactive, boolean includeVoided) Gets all visits for the specified patient
VisitType	getVisitType(java.lang.Integer visitTypeId) Gets a visit type by its visit type id.
VisitType	getVisitTypeByUuid(java.lang.String uuid) Gets a visit type by its UUID.
java.util.List<VisitType>	getVisitTypes(java.lang.String fuzzySearchPhrase) Gets all visit types whose names are similar to or contain the given search phrase.
void	purgeVisit(Visit visit) Completely erases a visit from the database.
void	purgeVisitAttributeType(VisitAttributeType visitAttributeType) Completely removes a visit attribute type from the database
void	purgeVisitType(VisitType visitType) Completely removes a visit type from the database.
VisitAttributeType	retireVisitAttributeType(VisitAttributeType visitAttributeType, java.lang.String reason) Retires the given visit attribute type in the database
VisitType	retireVisitType(VisitType visitType, java.lang.String reason) Retires a given visit type.
Visit	saveVisit(Visit visit) Creates or updates the given visit in the database.
VisitAttributeType	saveVisitAttributeType(VisitAttributeType visitAttributeType) Creates or updates the given visit attribute type in the database
VisitType	saveVisitType(VisitType visitType) Creates or updates the given visit type in the database.
void	setVisitDAO(VisitDAO dao) Method used to inject the visit data access object.
void	stopVisits(java.util.Date maximumStartDate) Stops all active visits started before or on the specified date which match any of the visit types specified by the OpenmrsConstants.GP_VISIT_TYPES_TO_AUTO_CLOSE global property.
VisitAttributeType	unretireVisitAttributeType(VisitAttributeType visitAttributeType) Restores a visit attribute type that was previous retired in the database
VisitType	unretireVisitType(VisitType visitType) Unretires a visit type.
Visit	unvoidVisit(Visit visit) Unvoids the given visit.
Visit	voidVisit(Visit visit, java.lang.String reason) Voids the given visit.

Methods inherited from class org.openmrs.api.impl.BaseOpenmrsService

onShutdown, onStartup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Constructor Detail

VisitServiceImpl

public VisitServiceImpl()

Method Detail

setVisitDAO

public void setVisitDAO(VisitDAO dao)

Method used to inject the visit data access object.

Parameters:

dao - the visit data access object.

getVisitDAO

public VisitDAO getVisitDAO()

getAllVisitTypes

public java.util.List<VisitType> getAllVisitTypes()

Description copied from interface: VisitService

Gets all visit types.

Specified by:

getAllVisitTypes in interface VisitService

Returns:

a list of visit type objects.

See Also:

VisitService.getAllVisitTypes()

getVisitType

public VisitType getVisitType(java.lang.Integer visitTypeId)

Description copied from interface: VisitService

Gets a visit type by its visit type id.

Specified by:

getVisitType in interface VisitService

Parameters:

visitTypeId - the visit type id.

Returns:

the visit type object found with the given id, else null.

See Also:

VisitService.getVisitType(java.lang.Integer)

getVisitTypeByUuid

public VisitType getVisitTypeByUuid(java.lang.String uuid)

Description copied from interface: VisitService

Gets a visit type by its UUID.

Specified by:

getVisitTypeByUuid in interface VisitService

Parameters:

uuid - the visit type UUID.

Returns:

the visit type object found with the given uuid, else null.

See Also:

VisitService.getVisitTypeByUuid(java.lang.String)

getVisitTypes

public java.util.List<VisitType> getVisitTypes(java.lang.String fuzzySearchPhrase)

Description copied from interface: VisitService

Gets all visit types whose names are similar to or contain the given search phrase.

Specified by:

getVisitTypes in interface VisitService

Parameters:

fuzzySearchPhrase - the search phrase to use.

Returns:

a list of all visit types with names similar to or containing the given phrase

See Also:

VisitService.getVisitTypes(java.lang.String)

saveVisitType

public VisitType saveVisitType(VisitType visitType)
                        throws APIException

Description copied from interface: VisitService

Creates or updates the given visit type in the database.

Specified by:

saveVisitType in interface VisitService

Parameters:

visitType - the visit type to create or update.

Returns:

the created or updated visit type.

Throws:

APIException

See Also:

VisitService.saveVisitType(org.openmrs.VisitType)

retireVisitType

public VisitType retireVisitType(VisitType visitType,
                                 java.lang.String reason)

Description copied from interface: VisitService

Retires a given visit type.

Specified by:

retireVisitType in interface VisitService

Parameters:

visitType - the visit type to retire.

reason - the reason why the visit type is retired.

Returns:

the visit type that has been retired.

See Also:

VisitService.retireVisitType(org.openmrs.VisitType, java.lang.String)

unretireVisitType

public VisitType unretireVisitType(VisitType visitType)

Description copied from interface: VisitService

Unretires a visit type.

Specified by:

unretireVisitType in interface VisitService

Parameters:

visitType - the visit type to unretire.

Returns:

the unretired visit type

See Also:

VisitService.unretireVisitType(org.openmrs.VisitType)

purgeVisitType

public void purgeVisitType(VisitType visitType)

Description copied from interface: VisitService

Completely removes a visit type from the database. This is not reversible.

Specified by:

purgeVisitType in interface VisitService

Parameters:

visitType - the visit type to delete from the database.

See Also:

VisitService.purgeVisitType(org.openmrs.VisitType)

getAllVisits

public java.util.List<Visit> getAllVisits()
                                   throws APIException

Description copied from interface: VisitService

Gets all unvoided visits in the database.

Specified by:

getAllVisits in interface VisitService

Returns:

a list of visit objects.

Throws:

APIException

See Also:

VisitService.getAllVisits()

getVisit

public Visit getVisit(java.lang.Integer visitId)
               throws APIException

Description copied from interface: VisitService

Gets a visit by its visit id.

Specified by:

getVisit in interface VisitService

Parameters:

visitId - the visit id.

Returns:

the visit object found with the given id, else null.

Throws:

APIException

See Also:

VisitService.getVisit(java.lang.Integer)

getVisitByUuid

public Visit getVisitByUuid(java.lang.String uuid)
                     throws APIException

Description copied from interface: VisitService

Gets a visit by its UUID.

Specified by:

getVisitByUuid in interface VisitService

Parameters:

uuid - the visit UUID.

Returns:

the visit object found with the given uuid, else null.

Throws:

APIException

See Also:

VisitService.getVisitByUuid(java.lang.String)

saveVisit

public Visit saveVisit(Visit visit)
                throws APIException

Description copied from interface: VisitService

Creates or updates the given visit in the database.

Specified by:

saveVisit in interface VisitService

Parameters:

visit - the visit to create or update.

Returns:

the created or updated visit.

Throws:

APIException

See Also:

VisitService.saveVisit(org.openmrs.Visit)

endVisit

public Visit endVisit(Visit visit,
                      java.util.Date stopDate)

Description copied from interface: VisitService

Sets the stopDate of a given visit.

Specified by:

endVisit in interface VisitService

Parameters:

visit - the visit whose stopDate is to be set

stopDate - the date and time the visit is ending. if null, current date is used

Returns:

the visit that was ended

See Also:

VisitService.endVisit(org.openmrs.Visit,java.util.Date)

voidVisit

public Visit voidVisit(Visit visit,
                       java.lang.String reason)
                throws APIException

Description copied from interface: VisitService

Voids the given visit.

Specified by:

voidVisit in interface VisitService

Parameters:

visit - the visit to void.

reason - the reason why the visit is voided

Returns:

the visit that has been voided

Throws:

APIException

See Also:

VisitService.voidVisit(org.openmrs.Visit, java.lang.String)

unvoidVisit

public Visit unvoidVisit(Visit visit)
                  throws APIException

Description copied from interface: VisitService

Unvoids the given visit.

Specified by:

unvoidVisit in interface VisitService

Parameters:

visit - the visit to unvoid

Returns:

the unvoided visit

Throws:

APIException

See Also:

VisitService.unvoidVisit(org.openmrs.Visit)

purgeVisit

public void purgeVisit(Visit visit)
                throws APIException

Description copied from interface: VisitService

Completely erases a visit from the database. This is not reversible.

Specified by:

purgeVisit in interface VisitService

Parameters:

visit - the visit to delete from the database.

Throws:

APIException

See Also:

VisitService.purgeVisit(org.openmrs.Visit)

getVisits

public java.util.List<Visit> getVisits(java.util.Collection<VisitType> visitTypes,
                                       java.util.Collection<Patient> patients,
                                       java.util.Collection<Location> locations,
                                       java.util.Collection<Concept> indications,
                                       java.util.Date minStartDatetime,
                                       java.util.Date maxStartDatetime,
                                       java.util.Date minEndDatetime,
                                       java.util.Date maxEndDatetime,
                                       java.util.Map<VisitAttributeType,java.lang.Object> attributeValues,
                                       boolean includeInactive,
                                       boolean includeVoided)
                                throws APIException

Description copied from interface: VisitService

Gets the visits matching the specified arguments

Specified by:

getVisits in interface VisitService

Parameters:

visitTypes - a list of visit types to match against

locations - a list of locations to match against

indications - a list of indication concepts to match against

minStartDatetime - the minimum visit start date to match against

maxStartDatetime - the maximum visit start date to match against

minEndDatetime - the minimum visit end date to match against

maxEndDatetime - the maximum visit end date to match against

includeInactive - if false, the min/maxEndDatetime parameters are ignored and only open visits are returned

includeVoided - specifies if voided visits should also be returned

Returns:

a list of visits

Throws:

APIException

See Also:

org.openmrs.api.VisitService#getVisits(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, java.util.Date, java.util.Date, java.util.Date, java.util.Date, boolean, boolean)

getVisitsByPatient

public java.util.List<Visit> getVisitsByPatient(Patient patient)
                                         throws APIException

Description copied from interface: VisitService

Gets all unvoided visits for the specified patient

Specified by:

getVisitsByPatient in interface VisitService

Parameters:

patient - the patient whose visits to get

Returns:

a list of visits

Throws:

APIException

See Also:

VisitService.getVisitsByPatient(org.openmrs.Patient)

getActiveVisitsByPatient

public java.util.List<Visit> getActiveVisitsByPatient(Patient patient)
                                               throws APIException

Description copied from interface: VisitService

Convenience method that delegates to getVisitsByPatient(patient, false, false)

Specified by:

getActiveVisitsByPatient in interface VisitService

Parameters:

patient - the patient whose visits to get

Returns:

a list of visits

Throws:

APIException

See Also:

VisitService.getActiveVisitsByPatient(org.openmrs.Patient)

getVisitsByPatient

public java.util.List<Visit> getVisitsByPatient(Patient patient,
                                                boolean includeInactive,
                                                boolean includeVoided)
                                         throws APIException

Description copied from interface: VisitService

Gets all visits for the specified patient

Specified by:

getVisitsByPatient in interface VisitService

Parameters:

patient - the patient whose visits to get

Returns:

a list of visits

Throws:

APIException

See Also:

VisitService.getVisitsByPatient(org.openmrs.Patient, boolean, boolean)

getAllVisitAttributeTypes

public java.util.List<VisitAttributeType> getAllVisitAttributeTypes()

Specified by:

getAllVisitAttributeTypes in interface VisitService

Returns:

all VisitAttributeTypes

See Also:

VisitService.getAllVisitAttributeTypes()

getVisitAttributeType

public VisitAttributeType getVisitAttributeType(java.lang.Integer id)

Specified by:

getVisitAttributeType in interface VisitService

Returns:

the VisitAttributeType with the given internal id

See Also:

VisitService.getVisitAttributeType(java.lang.Integer)

getVisitAttributeTypeByUuid

public VisitAttributeType getVisitAttributeTypeByUuid(java.lang.String uuid)

Specified by:

getVisitAttributeTypeByUuid in interface VisitService

Returns:

the VisitAttributeType with the given uuid

See Also:

VisitService.getVisitAttributeTypeByUuid(java.lang.String)

saveVisitAttributeType

public VisitAttributeType saveVisitAttributeType(VisitAttributeType visitAttributeType)

Description copied from interface: VisitService

Creates or updates the given visit attribute type in the database

Specified by:

saveVisitAttributeType in interface VisitService

Returns:

the VisitAttributeType created/saved

See Also:

VisitService.saveVisitAttributeType(org.openmrs.VisitAttributeType)

retireVisitAttributeType

public VisitAttributeType retireVisitAttributeType(VisitAttributeType visitAttributeType,
                                                   java.lang.String reason)

Description copied from interface: VisitService

Retires the given visit attribute type in the database

Specified by:

retireVisitAttributeType in interface VisitService

Returns:

the visitAttribute retired

See Also:

VisitService.retireVisitAttributeType(org.openmrs.VisitAttributeType, java.lang.String)

unretireVisitAttributeType

public VisitAttributeType unretireVisitAttributeType(VisitAttributeType visitAttributeType)

Description copied from interface: VisitService

Restores a visit attribute type that was previous retired in the database

Specified by:

unretireVisitAttributeType in interface VisitService

Returns:

the VisitAttributeType unretired

See Also:

VisitService.unretireVisitAttributeType(org.openmrs.VisitAttributeType)

purgeVisitAttributeType

public void purgeVisitAttributeType(VisitAttributeType visitAttributeType)

Description copied from interface: VisitService

Completely removes a visit attribute type from the database

Specified by:

purgeVisitAttributeType in interface VisitService

See Also:

VisitService.purgeVisitAttributeType(org.openmrs.VisitAttributeType)

getVisitAttributeByUuid

public VisitAttribute getVisitAttributeByUuid(java.lang.String uuid)

Specified by:

getVisitAttributeByUuid in interface VisitService

Returns:

the VisitAttribute with the given uuid

See Also:

VisitService.getVisitAttributeByUuid(java.lang.String)

stopVisits

public void stopVisits(java.util.Date maximumStartDate)

Description copied from interface: VisitService

Stops all active visits started before or on the specified date which match any of the visit types specified by the OpenmrsConstants.GP_VISIT_TYPES_TO_AUTO_CLOSE global property. If startDatetime is null, the default will be end of the current day.

Specified by:

stopVisits in interface VisitService

Parameters:

maximumStartDate - Visits started on or before this date time value will get stopped

See Also:

VisitService.stopVisits(Date)