PatientDAO (OpenMRS 2.7.0-SNAPSHOT API)

All Known Implementing Classes:

HibernatePatientDAO
```
public interface PatientDAO
```
Database methods for the PatientService

See Also:

Context, PatientService

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`deletePatient(Patient patient)` Delete patient from database.
`void`	`deletePatientIdentifier(PatientIdentifier patientIdentifier)`
`void`	`deletePatientIdentifierType(PatientIdentifierType patientIdentifierType)`
`List<Allergy>`	`getAllergies(Patient patient)` Gets a list of allergies that a patient has
`Allergy`	`getAllergy(Integer allergyId)` Gets a allergy matching the given allergyId
`Allergy`	`getAllergyByUuid(String uuid)` Gets a allergy matching the given uuid
`String`	`getAllergyStatus(Patient patient)` Gets a patient's allergy status
`List<PatientIdentifierType>`	`getAllPatientIdentifierTypes(boolean includeRetired)` Should not return null when includeRetired is false Should not return retired when includeRetired is false Should not return null when includeRetired is true Should return all when includeRetired is true
`List<Patient>`	`getAllPatients(boolean includeVoided)`
`Long`	`getCountOfPatients(String query)`
`Long`	`getCountOfPatients(String query, boolean includeVoided)`
`List<Patient>`	`getDuplicatePatientsByAttributes(List<String> attributes)`
`Patient`	`getPatient(Integer patientId)`
`Patient`	`getPatientByUuid(String uuid)`
`PatientIdentifier`	`getPatientIdentifier(Integer patientIdentifierId)`
`List`	`getPatientIdentifierByProgram(PatientProgram patientProgram)` Gets a List of Patient Identifiers associated to a program
`PatientIdentifier`	`getPatientIdentifierByUuid(String uuid)`
`List<PatientIdentifier>`	`getPatientIdentifiers(String identifier, List<PatientIdentifierType> patientIdentifierTypes, List<Location> locations, List<Patient> patients, Boolean isPreferred)`
`PatientIdentifierType`	`getPatientIdentifierType(Integer patientIdentifierTypeId)`
`PatientIdentifierType`	`getPatientIdentifierTypeByUuid(String uuid)`
`List<PatientIdentifierType>`	`getPatientIdentifierTypes(String name, String format, Boolean required, Boolean hasCheckDigit)`
`List<Patient>`	`getPatients(String query, boolean includeVoided, Integer start, Integer length)`
`List<Patient>`	`getPatients(String query, Integer start, Integer length)`
`List<Patient>`	`getPatients(String name, List<PatientIdentifierType> identifierTypes, boolean matchIdentifierExactly, Integer start, Integer length)`
`boolean`	`isIdentifierInUseByAnotherPatient(PatientIdentifier patientIdentifier)`
`Allergies`	`saveAllergies(Patient patient, Allergies allergies)` Saves patient allergies to the database.
`Allergy`	`saveAllergy(Allergy allergy)` Saves an allergy to the database
`Patient`	`savePatient(Patient patient)`
`PatientIdentifier`	`savePatientIdentifier(PatientIdentifier patientIdentifier)`
`PatientIdentifierType`	`savePatientIdentifierType(PatientIdentifierType patientIdentifierType)`

- Method Detail
  - savePatient
```
Patient savePatient(Patient patient)
             throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.savePatient(org.openmrs.Patient)
  - getPatient
```
Patient getPatient(Integer patientId)
            throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.getPatient(Integer)
  - deletePatient
```
void deletePatient(Patient patient)
            throws DAOException
```
    Delete patient from database. This should not be called except for testing and administration purposes. Use the void method instead
    
    Parameters:
    
    patient - patient to be deleted
    
    Throws:
    
    DAOException
    
    See Also:
    
    org.openmrs.api.PatientService#deletePatient(org.openmrs.Patient), PatientService.voidPatient(Patient, String)
  - getAllPatients
```
List<Patient> getAllPatients(boolean includeVoided)
                      throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.getAllPatients(boolean)
  - getPatients
```
List<Patient> getPatients(String query,
                          Integer start,
                          Integer length)
                   throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    Should not get patients by empty query _ signature no 2 Should not get patients by null query _ signature no 2 Should get patient by given name _ signature no 2 Should get patient by middle name _ signature no 2 Should get patient by family name _ signature no 2 Should get patient by family2 name _ signature no 2 Should get patient by whole name _ signature no 2 Should not get patient by non-existing single name _ signature no 2 Should not get patient by non-existing name parts _ signature no 2 Should not get patient by mix of existing and non-existing name parts _ signature no 2 Should not get patient by voided name _ signature no 2 Should get patient by short given name _ signature no 2 Should get patient by short middle name _ signature no 2 Should get patient by short family name _ signature no 2 Should get patient by short family2 name _ signature no 2 Should get patient by whole name made up of short names _ signature no 2 Should get patients by multiple short name parts _ signature no 2 Should not get patient by non-existing single short name _ signature no 2 Should not get patient by non-existing short name parts _ signature no 2 Should not get patient by mix of existing and non-existing short name parts _ signature no 2 Should not get patient by voided short name _ signature no 2 Should get patient by identifier _ signature no 2 Should not get patient by non-existing identifier _ signature no 2 Should not get patient by voided identifier _ signature no 2 Should get no patient by non-existing attribute _ signature no 2 Should get no patient by non-searchable attribute _ signature no 2 Should get no patient by voided attribute _ signature no 2 Should get one patient by attribute _ signature no 2 Should get one patient by random case attribute _ signature no 2 Should not get patients by searching for non-voided and voided attribute _ signature no 2 Should get multiple patients by single attribute _ signature no 2 Should not get patients by multiple attributes _ signature no 2 Should find eleven out of eleven patients _ signature no 2 Should find the first four out of eleven patients _ signature no 2 Should find the next four out of eleven patients _ signature no 2 Should find the remaining three out of eleven patients _ signature no 2 Should find patients with null as start _ signature no 2 Should find patients with negative start _ signature no 2 Should find patients with null as length _ signature no 2 Should not get patients by zero length _ signature no 2 Should not get patients by negative length _ signature no 2 Should find patients with excessive length _ signature no 2 Should return distinct patient list _ signature no 2 Should not match voided patients _ signature no 2 Should get patients with match mode start _ signature no 2 Should get patients with match mode anywhere _ signature no 2 Should not get patients with match mode start _ signature no 2 Should not get patients with match mode anywhere _ signature no 2
  - getPatients
```
List<Patient> getPatients(String query,
                          boolean includeVoided,
                          Integer start,
                          Integer length)
                   throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    Should get voided person when voided true is passed Should get no voided person when voided false is passed
  - getPatients
```
List<Patient> getPatients(String name,
                          List<PatientIdentifierType> identifierTypes,
                          boolean matchIdentifierExactly,
                          Integer start,
                          Integer length)
                   throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.getPatients(String, String, List, boolean, Integer, Integer)
  - getPatientIdentifiers
```
List<PatientIdentifier> getPatientIdentifiers(String identifier,
                                              List<PatientIdentifierType> patientIdentifierTypes,
                                              List<Location> locations,
                                              List<Patient> patients,
                                              Boolean isPreferred)
                                       throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    Should return all matching non voided patient identifiers if is preferred is set to null Should return all matching non voided patient identifiers if is preferred is set to true Should return all matching non voided patient identifiers if is preferred is set to false Should fetch all patient identifiers belong to given patient Should fetch all patient identifiers belong to given patients Should fetch patient identifiers that equals given identifier Should not fetch patient identifiers that partially matches given identifier Should not get voided patient identifiers
  - savePatientIdentifierType
```
PatientIdentifierType savePatientIdentifierType(PatientIdentifierType patientIdentifierType)
                                         throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.savePatientIdentifierType(org.openmrs.PatientIdentifierType)
  - getAllPatientIdentifierTypes
```
List<PatientIdentifierType> getAllPatientIdentifierTypes(boolean includeRetired)
                                                  throws DAOException
```
    Should not return null when includeRetired is false Should not return retired when includeRetired is false Should not return null when includeRetired is true Should return all when includeRetired is true
    
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.getAllPatientIdentifierTypes(boolean)
  - getPatientIdentifierTypes
```
List<PatientIdentifierType> getPatientIdentifierTypes(String name,
                                                      String format,
                                                      Boolean required,
                                                      Boolean hasCheckDigit)
                                               throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.getPatientIdentifierTypes(java.lang.String, java.lang.String, java.lang.Boolean, java.lang.Boolean)
  - getPatientIdentifierType
```
PatientIdentifierType getPatientIdentifierType(Integer patientIdentifierTypeId)
                                        throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.getPatientIdentifierType(java.lang.Integer)
  - deletePatientIdentifierType
```
void deletePatientIdentifierType(PatientIdentifierType patientIdentifierType)
                          throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.purgePatientIdentifierType(org.openmrs.PatientIdentifierType)
  - getDuplicatePatientsByAttributes
```
List<Patient> getDuplicatePatientsByAttributes(List<String> attributes)
                                        throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.getDuplicatePatientsByAttributes(java.util.List)
  - isIdentifierInUseByAnotherPatient
```
boolean isIdentifierInUseByAnotherPatient(PatientIdentifier patientIdentifier)
```
    See Also:
    
    PatientService.isIdentifierInUseByAnotherPatient(PatientIdentifier)
  - getPatientByUuid
```
Patient getPatientByUuid(String uuid)
```
    Parameters:
    
    uuid -
    
    Returns:
    
    patient or null
  - getPatientIdentifierByUuid
```
PatientIdentifier getPatientIdentifierByUuid(String uuid)
```
  - getPatientIdentifierTypeByUuid
```
PatientIdentifierType getPatientIdentifierTypeByUuid(String uuid)
```
    Parameters:
    
    uuid -
    
    Returns:
    
    patient identifier type or null
  - getPatientIdentifier
```
PatientIdentifier getPatientIdentifier(Integer patientIdentifierId)
                                throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.getPatientIdentifier(java.lang.Integer)
  - savePatientIdentifier
```
PatientIdentifier savePatientIdentifier(PatientIdentifier patientIdentifier)
```
    See Also:
    
    PatientService.savePatientIdentifier(org.openmrs.PatientIdentifier)
  - deletePatientIdentifier
```
void deletePatientIdentifier(PatientIdentifier patientIdentifier)
                      throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    PatientService.purgePatientIdentifier(org.openmrs.PatientIdentifier)
  - getCountOfPatients
```
Long getCountOfPatients(String query)
```
    See Also:
    
    Should count zero patients when query is empty _ signature no 2 Should count zero patients when query is null _ signature no 2 Should count zero patients for non-matching query _ signature no 2 Should not count voided patients _ signature no 2 Should count single patient _ signature no 2 Should count multiple patients _ signature no 2 Should count patients by name _ signature no 2 Should count patients by identifier _ signature no 2 Should count patients by searchable attribute _ signature no 2 Should obey attribute match mode
  - getCountOfPatients
```
Long getCountOfPatients(String query,
                        boolean includeVoided)
```
    See Also:
    
    PatientService.getCountOfPatients(String, boolean)
  - getAllergies
```
List<Allergy> getAllergies(Patient patient)
```
    Gets a list of allergies that a patient has
    
    Parameters:
    
    patient - the patient
    
    Returns:
    
    the allergy list
  - getAllergyStatus
```
String getAllergyStatus(Patient patient)
```
    Gets a patient's allergy status
    
    Parameters:
    
    patient - the patient
    
    Returns:
    
    the allergy status
  - saveAllergies
```
Allergies saveAllergies(Patient patient,
                        Allergies allergies)
```
    Saves patient allergies to the database.
    
    Parameters:
    
    patient - the patient
    
    allergies - the allergies
    
    Returns:
    
    the saved allergies
  - getAllergy
```
Allergy getAllergy(Integer allergyId)
```
    Gets a allergy matching the given allergyId
    
    Parameters:
    
    allergyId - of allergy to return
    
    Returns:
    
    the allergy matching the given allergyId Should return allergy given valid allergyId Should return null if no object found with given allergyId
  - getAllergyByUuid
```
Allergy getAllergyByUuid(String uuid)
```
    Gets a allergy matching the given uuid
    
    Parameters:
    
    uuid - of allergy to return
    
    Returns:
    
    the allergy matching the given uuid Should return allergy given valid uuid Should return null if no object found with given uuid
    
    Since:
    
    2.0
  - saveAllergy
```
Allergy saveAllergy(Allergy allergy)
```
    Saves an allergy to the database
    
    Parameters:
    
    allergy - the allergy to save
    
    Returns:
    
    the saved allergy
  - getPatientIdentifierByProgram
```
List getPatientIdentifierByProgram(PatientProgram patientProgram)
```
    Gets a List of Patient Identifiers associated to a program
    
    Parameters:
    
    patientProgram - the program that matches the patientIdentifier
    
    Returns:
    
    patient identifier or null

Interface PatientDAO

Method Summary

Method Detail

savePatient

getPatient

deletePatient

getAllPatients

getPatients

getPatients

getPatients

getPatientIdentifiers

savePatientIdentifierType

getAllPatientIdentifierTypes

getPatientIdentifierTypes

getPatientIdentifierType

deletePatientIdentifierType

getDuplicatePatientsByAttributes

isIdentifierInUseByAnotherPatient

getPatientByUuid

getPatientIdentifierByUuid

getPatientIdentifierTypeByUuid

getPatientIdentifier

savePatientIdentifier

deletePatientIdentifier

getCountOfPatients

getCountOfPatients

getAllergies

getAllergyStatus

saveAllergies

getAllergy

getAllergyByUuid

saveAllergy

getPatientIdentifierByProgram