org.openmrs.api.db.hibernate

Class HibernateVisitDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernateVisitDAO

All Implemented Interfaces:

VisitDAO

public class HibernateVisitDAO
extends Object
implements VisitDAO

Hibernate specific visit related functions This class should not be used directly. All calls should go through the VisitService methods.

Since:

1.9

Constructor Summary

Constructors

Constructor and Description
HibernateVisitDAO()

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
List<VisitAttributeType>	getAllVisitAttributeTypes()
List<VisitType>	getAllVisitTypes()
List<VisitType>	getAllVisitTypes(boolean includeRetired)
Visit	getNextVisit(Visit previousVisit, Collection<VisitType> visitTypes, Date maximumStartDate) Gets the next active visit which matches the specified visit types
Visit	getVisit(Integer visitId)
VisitAttribute	getVisitAttributeByUuid(String uuid)
VisitAttributeType	getVisitAttributeType(Integer id)
VisitAttributeType	getVisitAttributeTypeByUuid(String uuid)
Visit	getVisitByUuid(String uuid)
List<Visit>	getVisits(Collection<VisitType> visitTypes, Collection<Patient> patients, Collection<Location> locations, Collection<Concept> indications, Date minStartDatetime, Date maxStartDatetime, Date minEndDatetime, Date maxEndDatetime, Map<VisitAttributeType,String> serializedAttributeValues, boolean includeInactive, boolean includeVoided) Gets the visits matching the specified arguments
VisitType	getVisitType(Integer visitTypeId)
VisitType	getVisitTypeByUuid(String uuid)
List<VisitType>	getVisitTypes(String fuzzySearchPhrase)
void	purgeVisitType(VisitType visitType)
Visit	saveVisit(Visit visit)
VisitAttributeType	saveVisitAttributeType(VisitAttributeType visitAttributeType)
VisitType	saveVisitType(VisitType visitType)
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

HibernateVisitDAO

public HibernateVisitDAO()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

getAllVisitTypes

@Transactional(readOnly=true)
public List<VisitType> getAllVisitTypes()
                                                               throws APIException

Specified by:

getAllVisitTypes in interface VisitDAO

Throws:

APIException

See Also:

VisitDAO.getAllVisitTypes()

getAllVisitTypes

public List<VisitType> getAllVisitTypes(boolean includeRetired)
                                 throws DAOException

Specified by:

getAllVisitTypes in interface VisitDAO

Throws:

DAOException

See Also:

VisitDAO.getAllVisitTypes(boolean)

getVisitType

@Transactional(readOnly=true)
public VisitType getVisitType(Integer visitTypeId)

Specified by:

getVisitType in interface VisitDAO

See Also:

VisitDAO.getVisitType(java.lang.Integer)

getVisitTypeByUuid

@Transactional(readOnly=true)
public VisitType getVisitTypeByUuid(String uuid)

Specified by:

getVisitTypeByUuid in interface VisitDAO

See Also:

VisitDAO.getVisitTypeByUuid(java.lang.String)

getVisitTypes

@Transactional(readOnly=true)
public List<VisitType> getVisitTypes(String fuzzySearchPhrase)

Specified by:

getVisitTypes in interface VisitDAO

See Also:

VisitDAO.getVisitTypes(java.lang.String)

saveVisitType

@Transactional
public VisitType saveVisitType(VisitType visitType)

Specified by:

saveVisitType in interface VisitDAO

See Also:

VisitDAO.saveVisitType(org.openmrs.VisitType)

purgeVisitType

@Transactional
public void purgeVisitType(VisitType visitType)

Specified by:

purgeVisitType in interface VisitDAO

See Also:

VisitDAO.purgeVisitType(org.openmrs.VisitType)

getVisit

@Transactional(readOnly=true)
public Visit getVisit(Integer visitId)
                                             throws DAOException

Specified by:

getVisit in interface VisitDAO

Throws:

DAOException

See Also:

VisitDAO.getVisit(java.lang.Integer)

getVisitByUuid

@Transactional(readOnly=true)
public Visit getVisitByUuid(String uuid)
                                                   throws DAOException

Specified by:

getVisitByUuid in interface VisitDAO

Throws:

DAOException

See Also:

VisitDAO.getVisitByUuid(java.lang.String)

saveVisit

@Transactional
public Visit saveVisit(Visit visit)
                               throws DAOException

Specified by:

saveVisit in interface VisitDAO

Throws:

DAOException

See Also:

VisitDAO.saveVisit(org.openmrs.Visit)

deleteVisit

@Transactional
public void deleteVisit(Visit visit)
                                throws DAOException

Specified by:

deleteVisit in interface VisitDAO

Throws:

DAOException

See Also:

VisitDAO.deleteVisit(org.openmrs.Visit)

getVisits

@Transactional(readOnly=true)
public List<Visit> getVisits(Collection<VisitType> visitTypes,
                                                           Collection<Patient> patients,
                                                           Collection<Location> locations,
                                                           Collection<Concept> indications,
                                                           Date minStartDatetime,
                                                           Date maxStartDatetime,
                                                           Date minEndDatetime,
                                                           Date maxEndDatetime,
                                                           Map<VisitAttributeType,String> serializedAttributeValues,
                                                           boolean includeInactive,
                                                           boolean includeVoided)
                                                    throws DAOException

Description copied from interface: VisitDAO

Gets the visits matching the specified arguments

Specified by:

getVisits in interface VisitDAO

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 - Should return all unvoided visits if includeEnded is set to true Should return only active visits if includeEnded is set to false

See Also:

VisitDAO.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, java.util.Map, boolean, boolean)

getAllVisitAttributeTypes

@Transactional(readOnly=true)
public List<VisitAttributeType> getAllVisitAttributeTypes()

Specified by:

getAllVisitAttributeTypes in interface VisitDAO

See Also:

VisitDAO.getAllVisitAttributeTypes()

getVisitAttributeType

@Transactional(readOnly=true)
public VisitAttributeType getVisitAttributeType(Integer id)

Specified by:

getVisitAttributeType in interface VisitDAO

See Also:

VisitDAO.getVisitAttributeType(java.lang.Integer)

getVisitAttributeTypeByUuid

@Transactional(readOnly=true)
public VisitAttributeType getVisitAttributeTypeByUuid(String uuid)

Specified by:

getVisitAttributeTypeByUuid in interface VisitDAO

See Also:

VisitDAO.getVisitAttributeTypeByUuid(java.lang.String)

saveVisitAttributeType

@Transactional
public VisitAttributeType saveVisitAttributeType(VisitAttributeType visitAttributeType)

Specified by:

saveVisitAttributeType in interface VisitDAO

See Also:

VisitDAO.saveVisitAttributeType(org.openmrs.VisitAttributeType)

deleteVisitAttributeType

@Transactional
public void deleteVisitAttributeType(VisitAttributeType visitAttributeType)

Description copied from interface: VisitDAO

Completely removes a visit attribute type from the database

Specified by:

deleteVisitAttributeType in interface VisitDAO

See Also:

VisitDAO.deleteVisitAttributeType(org.openmrs.VisitAttributeType)

getVisitAttributeByUuid

@Transactional(readOnly=true)
public VisitAttribute getVisitAttributeByUuid(String uuid)

Specified by:

getVisitAttributeByUuid in interface VisitDAO

See Also:

VisitDAO.getVisitAttributeByUuid(java.lang.String)

getNextVisit

public Visit getNextVisit(Visit previousVisit,
                          Collection<VisitType> visitTypes,
                          Date maximumStartDate)

Description copied from interface: VisitDAO

Gets the next active visit which matches the specified visit types

Specified by:

getNextVisit in interface VisitDAO

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 Should return the next unvoided active visit matching the specified types and startDate

See Also:

VisitDAO.getNextVisit(Visit, Collection, Date)