VisitDAO (OpenMRS 2.7.0-SNAPSHOT API)

All Known Implementing Classes:

HibernateVisitDAO
```
public interface VisitDAO
```
Database access functions for visits.

Since:

1.9

Method Summary

All Methods Instance Methods Abstract Methods
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
`List<Visit>`	`getVisits(VisitSearchCriteria criteria)` Gets the visits matching the specified search criteria
`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)`

- Method Detail
  - getAllVisitTypes
```
List<VisitType> getAllVisitTypes()
                          throws APIException
```
    Throws:
    
    APIException
    
    See Also:
    
    VisitService.getAllVisitTypes()
  - getAllVisitTypes
```
List<VisitType> getAllVisitTypes(boolean includeRetired)
                          throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    VisitService.getAllVisitTypes(boolean)
  - getVisitType
```
VisitType getVisitType(Integer visitTypeId)
```
    See Also:
    
    VisitService.getVisitType(java.lang.Integer)
  - getVisitTypeByUuid
```
VisitType getVisitTypeByUuid(String uuid)
```
    See Also:
    
    VisitService.getVisitTypeByUuid(java.lang.String)
  - getVisitTypes
```
List<VisitType> getVisitTypes(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(Integer visitId)
        throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    VisitService.getVisit(Integer)
  - getVisitByUuid
```
Visit getVisitByUuid(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
```
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
```
    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 - Should return all unvoided visits if includeEnded is set to true Should return only active visits if includeEnded is set to false
  - getVisits
```
List<Visit> getVisits(VisitSearchCriteria criteria)
               throws DAOException
```
    Gets the visits matching the specified search criteria
    
    Parameters:
    
    criteria - the search criteria
    
    Returns:
    
    a list of visits
    
    Throws:
    
    DAOException
    
    Since:
    
    2.6.8, 2.7.0
  - getAllVisitAttributeTypes
```
List<VisitAttributeType> getAllVisitAttributeTypes()
```
    See Also:
    
    VisitService.getAllVisitAttributeTypes()
  - getVisitAttributeType
```
VisitAttributeType getVisitAttributeType(Integer id)
```
    See Also:
    
    VisitService.getVisitAttributeType(Integer)
  - getVisitAttributeTypeByUuid
```
VisitAttributeType getVisitAttributeTypeByUuid(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(String uuid)
```
    See Also:
    
    VisitService.getVisitAttributeByUuid(String)
  - getNextVisit
```
Visit getNextVisit(Visit previousVisit,
                   Collection<VisitType> visitTypes,
                   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 Should return the next unvoided active visit matching the specified types and startDate

Interface VisitDAO

Method Summary

Method Detail

getAllVisitTypes

getAllVisitTypes

getVisitType

getVisitTypeByUuid

getVisitTypes

saveVisitType

purgeVisitType

getVisit

getVisitByUuid

saveVisit

deleteVisit

getVisits

getVisits

getAllVisitAttributeTypes

getVisitAttributeType

getVisitAttributeTypeByUuid

saveVisitAttributeType

deleteVisitAttributeType

getVisitAttributeByUuid

getNextVisit