org.openmrs.api.db

Interface VisitDAO

All Known Implementing Classes:

HibernateVisitDAO

public interface VisitDAO

Database access functions for visits.

Since:

1.9

Method Summary

Modifier and Type	Method and Description
void	deleteVisit(Visit visit)
void	deleteVisitAttributeType(VisitAttributeType visitAttributeType) Completely removes a visit attribute type from the database
java.util.List<VisitAttributeType>	getAllVisitAttributeTypes()
java.util.List<VisitType>	getAllVisitTypes()
Visit	getNextVisit(Visit previousVisit, java.util.Collection<VisitType> visitTypes, java.util.Date maximumStartDate) Gets the next active visit which matches the specified visit types
Visit	getVisit(java.lang.Integer visitId)
VisitAttribute	getVisitAttributeByUuid(java.lang.String uuid)
VisitAttributeType	getVisitAttributeType(java.lang.Integer id)
VisitAttributeType	getVisitAttributeTypeByUuid(java.lang.String uuid)
Visit	getVisitByUuid(java.lang.String uuid)
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.String> serializedAttributeValues, boolean includeInactive, boolean includeVoided) Gets the visits matching the specified arguments
VisitType	getVisitType(java.lang.Integer visitTypeId)
VisitType	getVisitTypeByUuid(java.lang.String uuid)
java.util.List<VisitType>	getVisitTypes(java.lang.String fuzzySearchPhrase)
void	purgeVisitType(VisitType visitType)
Visit	saveVisit(Visit visit)
VisitAttributeType	saveVisitAttributeType(VisitAttributeType visitAttributeType)
VisitType	saveVisitType(VisitType visitType)

Method Detail

getAllVisitTypes

java.util.List<VisitType> getAllVisitTypes()
                                    throws APIException

Throws:

APIException

See Also:

VisitService.getAllVisitTypes()

getVisitType

VisitType getVisitType(java.lang.Integer visitTypeId)

See Also:

VisitService.getVisitType(java.lang.Integer)

getVisitTypeByUuid

VisitType getVisitTypeByUuid(java.lang.String uuid)

See Also:

VisitService.getVisitTypeByUuid(java.lang.String)

getVisitTypes

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

See Also:

VisitService.getVisitTypes(java.lang.String)

saveVisitType

VisitType saveVisitType(VisitType visitType)

See Also:

VisitService.saveVisitType(org.openmrs.VisitType)

purgeVisitType

void purgeVisitType(VisitType visitType)

See Also:

VisitService.purgeVisitType(org.openmrs.VisitType)

getVisit

Visit getVisit(java.lang.Integer visitId)
        throws DAOException

Throws:

DAOException

See Also:

VisitService.getVisit(Integer)

getVisitByUuid

Visit getVisitByUuid(java.lang.String uuid)
              throws DAOException

Throws:

DAOException

See Also:

VisitService.getVisitByUuid(String)

saveVisit

Visit saveVisit(Visit visit)
         throws DAOException

Throws:

DAOException

See Also:

VisitService.saveVisit(Visit)

deleteVisit

void deleteVisit(Visit visit)
          throws DAOException

Throws:

DAOException

See Also:

VisitService.purgeVisit(Visit)

getVisits

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.String> serializedAttributeValues,
                                boolean includeInactive,
                                boolean includeVoided)
                         throws DAOException

Gets the visits matching the specified arguments

Parameters:

visitTypes - a list of visit types to match against

patients - a list of patients 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 - specifies if inactive visits should be returned or not

includeVoided - specifies if voided visits should also be returned

Returns:

a list of visits

Throws:

DAOException

getAllVisitAttributeTypes

java.util.List<VisitAttributeType> getAllVisitAttributeTypes()

See Also:

VisitService.getAllVisitAttributeTypes()

getVisitAttributeType

VisitAttributeType getVisitAttributeType(java.lang.Integer id)

See Also:

VisitService.getVisitAttributeType(Integer)

getVisitAttributeTypeByUuid

VisitAttributeType getVisitAttributeTypeByUuid(java.lang.String uuid)

See Also:

VisitService.getVisitAttributeTypeByUuid(String)

saveVisitAttributeType

VisitAttributeType saveVisitAttributeType(VisitAttributeType visitAttributeType)

See Also:

VisitService.saveVisitAttributeType(VisitAttributeType)

deleteVisitAttributeType

void deleteVisitAttributeType(VisitAttributeType visitAttributeType)

Completely removes a visit attribute type from the database

Parameters:

visitAttributeType -

getVisitAttributeByUuid

VisitAttribute getVisitAttributeByUuid(java.lang.String uuid)

See Also:

VisitService.getVisitAttributeByUuid(String)

getNextVisit

Visit getNextVisit(Visit previousVisit,
                   java.util.Collection<VisitType> visitTypes,
                   java.util.Date maximumStartDate)

Gets the next active visit which matches the specified visit types

Parameters:

previousVisit - the visit that precedes the one we are fetching

visitTypes - a collection of visit types to match against

maximumStartDate - the next visit should have been created before or at this date time

Returns:

a Visit