|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.openmrs.api.impl.BaseOpenmrsService
org.openmrs.api.impl.EncounterServiceImpl
public class EncounterServiceImpl
Default implementation of the EncounterService
This class should not be instantiated alone, get a service class from the Context: Context.getEncounterService();
Context,
EncounterService| Constructor Summary | |
|---|---|
EncounterServiceImpl()
|
|
| Method Summary | |
|---|---|
void |
createEncounter(Encounter encounter)
Deprecated. replaced by saveEncounter(Encounter) |
void |
deleteEncounter(Encounter encounter)
Deprecated. Replaced by purgeEncounter(Encounter) |
java.util.List<EncounterType> |
findEncounterTypes(java.lang.String name)
Find Encounter Types with name matching the beginning of the search string. |
java.util.List<Location> |
findLocations(java.lang.String name)
Deprecated. use LocationService.getLocations(name) |
java.util.List<EncounterType> |
getAllEncounterTypes()
Get all encounter types (not retired) |
java.util.List<EncounterType> |
getAllEncounterTypes(boolean includeVoided)
Get all encounter types. |
Encounter |
getEncounter(java.lang.Integer encounterId)
Get encounter by internal identifier |
Encounter |
getEncounterByUuid(java.lang.String uuid)
Get Encounter by its UUID |
java.util.Collection<Encounter> |
getEncounters(java.util.Date fromDate,
java.util.Date toDate)
Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean) |
java.util.List<Encounter> |
getEncounters(Location loc,
java.util.Date fromDate,
java.util.Date toDate)
Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean) |
java.util.List<Encounter> |
getEncounters(Patient who)
Deprecated. replaced by getEncountersByPatient(Patient patient) |
java.util.List<Encounter> |
getEncounters(Patient who,
boolean includeVoided)
Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean) |
java.util.List<Encounter> |
getEncounters(Patient who,
java.util.Date fromDate,
java.util.Date toDate)
Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean) |
java.util.List<Encounter> |
getEncounters(Patient who,
Location where)
Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean) |
java.util.List<Encounter> |
getEncounters(Patient who,
Location loc,
java.util.Date fromDate,
java.util.Date toDate,
java.util.Collection<Form> enteredViaForms,
java.util.Collection<EncounterType> encounterTypes,
boolean includeVoided)
Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean) |
java.util.List<Encounter> |
getEncounters(Patient who,
Location loc,
java.util.Date fromDate,
java.util.Date toDate,
java.util.Collection<Form> enteredViaForms,
java.util.Collection<EncounterType> encounterTypes,
java.util.Collection<User> providers,
boolean includeVoided)
Get all encounters that match a variety of (nullable) criteria. |
java.util.List<Encounter> |
getEncountersByPatient(Patient patient)
Get all encounters (not voided) for a patient. |
java.util.List<Encounter> |
getEncountersByPatient(java.lang.String query)
Search for encounters by patient name or patient identifier. |
java.util.List<Encounter> |
getEncountersByPatient(java.lang.String query,
boolean includeVoided)
Search for encounters by patient name or patient identifier. |
java.util.List<Encounter> |
getEncountersByPatientId(java.lang.Integer patientId)
Get encounters for a patientId |
java.util.List<Encounter> |
getEncountersByPatientId(java.lang.Integer patientId,
boolean includeVoided)
Deprecated. replaced by getEncountersByPatientId(Integer) |
java.util.List<Encounter> |
getEncountersByPatientIdentifier(java.lang.String identifier)
Get encounters (not voided) for a patient identifier |
java.util.List<Encounter> |
getEncountersByPatientIdentifier(java.lang.String identifier,
boolean includeVoided)
Deprecated. replaced by getEncountersByPatientIdentifier(String) |
EncounterType |
getEncounterType(java.lang.Integer encounterTypeId)
Get encounterType by internal identifier |
EncounterType |
getEncounterType(java.lang.String name)
Get encounterType by exact name |
EncounterType |
getEncounterTypeByUuid(java.lang.String uuid)
Get EncounterType by its UUID |
java.util.List<EncounterType> |
getEncounterTypes()
Deprecated. replaced by getAllEncounterTypes() |
Location |
getLocation(java.lang.Integer locationId)
Deprecated. use LocationService.getLocation(locationId) |
Location |
getLocationByName(java.lang.String name)
Deprecated. use LocationService.getLocation(name) |
java.util.List<Location> |
getLocations()
Deprecated. use LocationService.getAllLocations() |
void |
purgeEncounter(Encounter encounter)
Completely remove an encounter from database. |
void |
purgeEncounter(Encounter encounter,
boolean cascade)
Completely remove an encounter from database. |
void |
purgeEncounterType(EncounterType encounterType)
Completely remove an encounter type from database. |
EncounterType |
retireEncounterType(EncounterType encounterType,
java.lang.String reason)
Retire an EncounterType. |
Encounter |
saveEncounter(Encounter encounter)
Saves a new encounter or updates an existing encounter. |
EncounterType |
saveEncounterType(EncounterType encounterType)
Save a new Encounter Type or update an existing Encounter Type. |
void |
setEncounterDAO(EncounterDAO dao)
Set the given dao on this encounter service. |
EncounterType |
unretireEncounterType(EncounterType encounterType)
Unretire an EncounterType. |
Encounter |
unvoidEncounter(Encounter encounter)
Unvoid encounter record |
void |
updateEncounter(Encounter encounter)
Deprecated. replaced by saveEncounter(Encounter) |
Encounter |
voidEncounter(Encounter encounter,
java.lang.String reason)
Voiding a encounter essentially removes it from circulation |
| 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 |
|---|
public EncounterServiceImpl()
| Method Detail |
|---|
public void setEncounterDAO(EncounterDAO dao)
EncounterServicedao on this encounter service. The dao will act as the conduit
through with all encounter calls get to the database
setEncounterDAO in interface EncounterServiceEncounterService.setEncounterDAO(org.openmrs.api.db.EncounterDAO)
public java.util.List<Encounter> getEncountersByPatient(java.lang.String query,
boolean includeVoided)
throws APIException
EncounterService
getEncountersByPatient in interface EncounterServicequery - patient name or identifierincludeVoided - Specifies whether voided encounters should be included
APIExceptionEncounterService.getEncountersByPatient(java.lang.String, boolean)
public Encounter saveEncounter(Encounter encounter)
throws APIException
EncounterService
saveEncounter in interface EncounterServiceencounter - to be saved
APIExceptionEncounterService.saveEncounter(org.openmrs.Encounter)
public Encounter getEncounter(java.lang.Integer encounterId)
throws APIException
EncounterService
getEncounter in interface EncounterServiceencounterId - encounter id
APIExceptionEncounterService.getEncounter(java.lang.Integer)
public java.util.List<Encounter> getEncountersByPatient(Patient patient)
throws APIException
EncounterService
getEncountersByPatient in interface EncounterServiceAPIExceptionEncounterService.getEncountersByPatient(org.openmrs.Patient)
public java.util.List<Encounter> getEncountersByPatient(java.lang.String query)
throws APIException
EncounterService
getEncountersByPatient in interface EncounterServicequery - patient name or identifier
APIExceptionEncounterService.getEncountersByPatient(String)
public java.util.List<Encounter> getEncountersByPatientId(java.lang.Integer patientId)
throws APIException
EncounterService
getEncountersByPatientId in interface EncounterServiceAPIExceptionEncounterService.getEncountersByPatientId(java.lang.Integer)
public java.util.List<Encounter> getEncountersByPatientIdentifier(java.lang.String identifier)
throws APIException
EncounterService
getEncountersByPatientIdentifier in interface EncounterServiceAPIExceptionEncounterService.getEncountersByPatientIdentifier(java.lang.String)
@Deprecated
public java.util.List<Encounter> getEncounters(Patient who,
Location loc,
java.util.Date fromDate,
java.util.Date toDate,
java.util.Collection<Form> enteredViaForms,
java.util.Collection<EncounterType> encounterTypes,
boolean includeVoided)
getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
getEncounters in interface EncounterServiceEncounterService.getEncounters(org.openmrs.Patient,
org.openmrs.Location, java.util.Date, java.util.Date, java.util.Collection,
java.util.Collection, boolean)
public java.util.List<Encounter> getEncounters(Patient who,
Location loc,
java.util.Date fromDate,
java.util.Date toDate,
java.util.Collection<Form> enteredViaForms,
java.util.Collection<EncounterType> encounterTypes,
java.util.Collection<User> providers,
boolean includeVoided)
EncounterService
getEncounters in interface EncounterServicewho - the patient the encounter is forloc - the location this encounter took placefromDate - the minimum date (inclusive) this encounter took placetoDate - the maximum date (exclusive) this encounter took placeenteredViaForms - the form that entered this encounter must be in this listencounterTypes - the type of encounter must be in this listproviders - the provider of this encounter must be in this listincludeVoided - true/false to include the voided encounters or not
EncounterService.getEncounters(org.openmrs.Patient,
org.openmrs.Location, java.util.Date, java.util.Date, java.util.Collection,
java.util.Collection, java.util.Collection, boolean)
public Encounter voidEncounter(Encounter encounter,
java.lang.String reason)
EncounterService
voidEncounter in interface EncounterServiceencounter - Encounter object to voidreason - String reason that it's being voidedEncounterService.voidEncounter(org.openmrs.Encounter, java.lang.String)
public Encounter unvoidEncounter(Encounter encounter)
throws APIException
EncounterService
unvoidEncounter in interface EncounterServiceencounter - Encounter to be revived
APIExceptionEncounterService.unvoidEncounter(org.openmrs.Encounter)
public void purgeEncounter(Encounter encounter)
throws APIException
EncounterServicevoidEncounter(org.openmrs.Encounter)
purgeEncounter in interface EncounterServiceencounter - encounter object to be purged
APIExceptionEncounterService.purgeEncounter(org.openmrs.Encounter)
public void purgeEncounter(Encounter encounter,
boolean cascade)
throws APIException
EncounterServicevoidEncounter(org.openmrs.Encounter)
purgeEncounter in interface EncounterServiceencounter - encounter object to be purgedcascade - Purge any related observations as well?
APIExceptionEncounterService.purgeEncounter(Encounter, boolean)public EncounterType saveEncounterType(EncounterType encounterType)
EncounterService
saveEncounterType in interface EncounterServiceEncounterService.saveEncounterType(org.openmrs.EncounterType)
public EncounterType getEncounterType(java.lang.Integer encounterTypeId)
throws APIException
EncounterService
getEncounterType in interface EncounterServiceencounterTypeId - Integer
APIExceptionEncounterService.getEncounterType(java.lang.Integer)
public EncounterType getEncounterType(java.lang.String name)
throws APIException
EncounterService
getEncounterType in interface EncounterServicename - string to match to an Encounter.name
APIExceptionEncounterService.getEncounterType(java.lang.String)
public java.util.List<EncounterType> getAllEncounterTypes()
throws APIException
EncounterService
getAllEncounterTypes in interface EncounterServiceAPIExceptionEncounterService.getAllEncounterTypes()
public java.util.List<EncounterType> getAllEncounterTypes(boolean includeVoided)
throws APIException
EncounterService
getAllEncounterTypes in interface EncounterServiceAPIExceptionEncounterService.getAllEncounterTypes(boolean)
public java.util.List<EncounterType> findEncounterTypes(java.lang.String name)
throws APIException
EncounterService
findEncounterTypes in interface EncounterServicename - of the encounter type to find
APIExceptionEncounterService.findEncounterTypes(java.lang.String)
public EncounterType retireEncounterType(EncounterType encounterType,
java.lang.String reason)
throws APIException
EncounterService
retireEncounterType in interface EncounterServiceencounterType - the encounter type to retirereason - required non-null purpose for retiring this encounter type
APIExceptionEncounterService.retireEncounterType(EncounterType, String)
public EncounterType unretireEncounterType(EncounterType encounterType)
throws APIException
EncounterService
unretireEncounterType in interface EncounterServiceencounterType - the encounter type to unretire
APIExceptionEncounterService.unretireEncounterType(org.openmrs.EncounterType)
public void purgeEncounterType(EncounterType encounterType)
throws APIException
EncounterService
purgeEncounterType in interface EncounterServiceAPIExceptionEncounterService.purgeEncounterType(org.openmrs.EncounterType)
@Deprecated
public void createEncounter(Encounter encounter)
throws APIException
saveEncounter(Encounter)
EncounterService
createEncounter in interface EncounterServiceencounter - to be created
APIExceptionEncounterService.createEncounter(org.openmrs.Encounter)
@Deprecated
public void updateEncounter(Encounter encounter)
throws APIException
saveEncounter(Encounter)
EncounterService
updateEncounter in interface EncounterServiceAPIExceptionEncounterService.updateEncounter(org.openmrs.Encounter)
@Deprecated
public void deleteEncounter(Encounter encounter)
throws APIException
purgeEncounter(Encounter)
EncounterServicevoidEncounter(org.openmrs.Encounter)
deleteEncounter in interface EncounterServiceencounter - encounter object to be deleted
APIExceptionEncounterService.deleteEncounter(org.openmrs.Encounter)
@Deprecated
public java.util.List<Encounter> getEncountersByPatientId(java.lang.Integer patientId,
boolean includeVoided)
throws APIException
getEncountersByPatientId(Integer)
EncounterServiceEncounterService.getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)
getEncountersByPatientId in interface EncounterServiceincludeVoided - No longer supported
APIExceptionEncounterService.getEncountersByPatientId(java.lang.Integer, boolean)
@Deprecated
public java.util.List<Encounter> getEncountersByPatientIdentifier(java.lang.String identifier,
boolean includeVoided)
throws APIException
getEncountersByPatientIdentifier(String)
EncounterServiceEncounterService.getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)
getEncountersByPatientIdentifier in interface EncounterServiceincludeVoided - No longer supported.
APIExceptionEncounterService.getEncountersByPatientIdentifier(java.lang.String,
boolean)@Deprecated public java.util.List<Encounter> getEncounters(Patient who)
getEncountersByPatient(Patient patient)
EncounterService
getEncounters in interface EncounterServiceEncounterService.getEncounters(org.openmrs.Patient)
@Deprecated
public java.util.List<Encounter> getEncounters(Patient who,
boolean includeVoided)
getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
EncounterServiceEncounterService.getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)
getEncounters in interface EncounterServiceincludeVoided - No longer supported.
EncounterService.getEncounters(org.openmrs.Patient, boolean)
@Deprecated
public java.util.List<Encounter> getEncounters(Patient who,
Location where)
getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
EncounterService
getEncounters in interface EncounterServiceEncounterService.getEncounters(org.openmrs.Patient,
org.openmrs.Location)
@Deprecated
public java.util.List<Encounter> getEncounters(Patient who,
java.util.Date fromDate,
java.util.Date toDate)
getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
EncounterService
getEncounters in interface EncounterServiceEncounterService.getEncounters(org.openmrs.Patient, java.util.Date,
java.util.Date)
@Deprecated
public java.util.Collection<Encounter> getEncounters(java.util.Date fromDate,
java.util.Date toDate)
getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
EncounterService
getEncounters in interface EncounterServiceEncounterService.getEncounters(java.util.Date, java.util.Date)
@Deprecated
public java.util.List<Encounter> getEncounters(Location loc,
java.util.Date fromDate,
java.util.Date toDate)
getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
EncounterService
getEncounters in interface EncounterServiceloc - Location
EncounterService.getEncounters(org.openmrs.Location, java.util.Date,
java.util.Date)@Deprecated public java.util.List<EncounterType> getEncounterTypes()
getAllEncounterTypes()
EncounterService
getEncounterTypes in interface EncounterServiceEncounterService.getEncounterTypes()
@Deprecated
public java.util.List<Location> getLocations()
throws APIException
EncounterService
getLocations in interface EncounterServiceAPIExceptionEncounterService.getLocations()
@Deprecated
public Location getLocation(java.lang.Integer locationId)
throws APIException
EncounterService
getLocation in interface EncounterServiceAPIExceptionEncounterService.getLocation(java.lang.Integer)
@Deprecated
public Location getLocationByName(java.lang.String name)
throws APIException
EncounterService
getLocationByName in interface EncounterServicename - location's name
APIExceptionEncounterService.getLocationByName(java.lang.String)
@Deprecated
public java.util.List<Location> findLocations(java.lang.String name)
throws APIException
EncounterService
findLocations in interface EncounterServicename - location's name
APIExceptionEncounterService.findLocations(java.lang.String)
public Encounter getEncounterByUuid(java.lang.String uuid)
throws APIException
EncounterService
getEncounterByUuid in interface EncounterServiceAPIExceptionEncounterService.getEncounterByUuid(java.lang.String)
public EncounterType getEncounterTypeByUuid(java.lang.String uuid)
throws APIException
EncounterService
getEncounterTypeByUuid in interface EncounterServiceAPIExceptionEncounterService.getEncounterTypeByUuid(java.lang.String)
|
OpenMRS-1.7.x | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||