org.openmrs.web.dwr

Class DWRPatientService

java.lang.Object

org.openmrs.web.dwr.DWRPatientService

All Implemented Interfaces:

GlobalPropertyListener

public class DWRPatientService
extends Object
implements GlobalPropertyListener

DWR patient methods. The methods in here are used in the webapp to get data from the database via javascript calls.

See Also:

PatientService

Constructor Summary

Constructors

Constructor and Description
DWRPatientService()

Method Summary

Modifier and Type	Method and Description
String	addIdentifier(Integer patientId, String identifierType, String identifier, Integer identifierLocationId)
String	changeHealthCenter(Integer patientId, Integer locationId)
String	exitPatientFromCare(Integer patientId, Integer exitReasonId, String exitDateStr, Integer causeOfDeathConceptId, String otherReason)
Collection<Object>	findBatchOfPatients(String searchValue, boolean includeVoided, Integer start, Integer length) Search on the searchValue.
Map<String,Object>	findCountAndPatients(String searchValue, Integer start, Integer length, boolean getMatchCount) Returns a map of results with the values as count of matches and a partial list of the matching patients (depending on values of start and length parameters) while the keys are are 'count' and 'objectList' respectively, if the length parameter is not specified, then all matches will be returned from the start index if specified.
Map<String,Object>	findCountAndPatientsWithVoided(String searchValue, Integer start, Integer length, boolean getMatchCount, Boolean includeVoided) Returns a map of results with the values as count of matches and a partial list of the matching patients (depending on values of start and length parameters) while the keys are are 'count' and 'objectList' respectively, if the length parameter is not specified, then all matches will be returned from the start index if specified.
Vector<Object>	findDuplicatePatients(String[] searchOn) find all patients with duplicate attributes (searchOn)
Collection<Object>	findPatients(String searchValue, boolean includeVoided) Search on the searchValue.
PatientListItem	getPatient(Integer patientId) Convenience method for dwr/javascript to convert a patient id into a Patient object (or at least into data about the patient)
void	globalPropertyChanged(GlobalProperty newValue) Called after a global property is created or updated
void	globalPropertyDeleted(String propertyName) Called after a global property is deleted
static void	setMaximumResults(Integer maximumResults)
boolean	supportsPropertyName(String propertyName) Asks this listener whether it wants to be notified about the given property name

Methods inherited from class java.lang.Object

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

Constructor Detail

DWRPatientService

public DWRPatientService()

Method Detail

findPatients

public Collection<Object> findPatients(String searchValue,
                                       boolean includeVoided)

Search on the searchValue. If a number is in the search string, do an identifier search. Else, do a name search

Parameters:

searchValue - string to be looked for

includeVoided - true/false whether or not to included voided patients

Returns:

Collection<Object> of PatientListItem or String

Expected Behavior:

Should return only patient list items with nonnumeric search

Should return string warning if invalid patient identifier

Should not return string warning if searching with valid identifier

Should include string in results if doing extra decapitated search

Should not return duplicate patient list items if doing decapitated search

Should not do decapitated search if numbers are in the search string

Should get results for patients that have edited themselves

Should logged in user should load their own patient object

setMaximumResults

public static void setMaximumResults(Integer maximumResults)

findBatchOfPatients

public Collection<Object> findBatchOfPatients(String searchValue,
                                              boolean includeVoided,
                                              Integer start,
                                              Integer length)

Search on the searchValue. If a number is in the search string, do an identifier search. Else, do a name search

Parameters:

searchValue - string to be looked for

includeVoided - true/false whether or not to included voided patients

start - The starting index for the results to return

length - The number of results of return

Returns:

Collection<Object> of PatientListItem or String

Since:

1.8

See Also:

PatientService.getPatients(String, String, List, boolean, Integer, Integer)

findCountAndPatientsWithVoided

public Map<String,Object> findCountAndPatientsWithVoided(String searchValue,
                                                         Integer start,
                                                         Integer length,
                                                         boolean getMatchCount,
                                                         Boolean includeVoided)
                                                  throws APIException

Returns a map of results with the values as count of matches and a partial list of the matching patients (depending on values of start and length parameters) while the keys are are 'count' and 'objectList' respectively, if the length parameter is not specified, then all matches will be returned from the start index if specified.

Parameters:

searchValue - patient name or identifier

includeVoided - true/false whether or not to included voided patients

start - the beginning index

length - the number of matching patients to return

getMatchCount - Specifies if the count of matches should be included in the returned map

Returns:

a map of results

Throws:

APIException

findCountAndPatients

public Map<String,Object> findCountAndPatients(String searchValue,
                                               Integer start,
                                               Integer length,
                                               boolean getMatchCount)
                                        throws APIException

Returns a map of results with the values as count of matches and a partial list of the matching patients (depending on values of start and length parameters) while the keys are are 'count' and 'objectList' respectively, if the length parameter is not specified, then all matches will be returned from the start index if specified.

Parameters:

searchValue - patient name or identifier

start - the beginning index

length - the number of matching patients to return

getMatchCount - Specifies if the count of matches should be included in the returned map

Returns:

a map of results

Throws:

APIException

Since:

1.8

Expected Behavior:

Should signal for a new search if the new search value has matches and is a first call

Should not signal for a new search if it is not the first ajax call

Should not signal for a new search if the new search value has no matches

Should match patient with identifiers that contain no digit

getPatient

public PatientListItem getPatient(Integer patientId)

Convenience method for dwr/javascript to convert a patient id into a Patient object (or at least into data about the patient)

Parameters:

patientId - the Patient.getPatientId() to match on

Returns:

a truncated Patient object in the form of a PatientListItem

findDuplicatePatients

public Vector<Object> findDuplicatePatients(String[] searchOn)

find all patients with duplicate attributes (searchOn)

Parameters:

searchOn -

Returns:

list of patientListItems

addIdentifier

public String addIdentifier(Integer patientId,
                            String identifierType,
                            String identifier,
                            Integer identifierLocationId)

Parameters:

patientId -

identifierType -

identifier -

identifierLocationId -

Returns:

empty string or, in case of an error, a message key for the error description

exitPatientFromCare

public String exitPatientFromCare(Integer patientId,
                                  Integer exitReasonId,
                                  String exitDateStr,
                                  Integer causeOfDeathConceptId,
                                  String otherReason)

Parameters:

patientId -

exitReasonId -

exitDateStr -

causeOfDeathConceptId -

otherReason -

Returns:

empty string or, in case of an error, a description of the error

changeHealthCenter

public String changeHealthCenter(Integer patientId,
                                 Integer locationId)

Parameters:

patientId -

locationId -

Returns:

empty string

supportsPropertyName

public boolean supportsPropertyName(String propertyName)

Description copied from interface: GlobalPropertyListener

Asks this listener whether it wants to be notified about the given property name

Specified by:

supportsPropertyName in interface GlobalPropertyListener

Returns:

whether this listener wants its action methods to be notified of properties with the given name

globalPropertyChanged

public void globalPropertyChanged(GlobalProperty newValue)

Description copied from interface: GlobalPropertyListener

Called after a global property is created or updated

Specified by:

globalPropertyChanged in interface GlobalPropertyListener

Parameters:

newValue - the new value of the property that was just saved

globalPropertyDeleted

public void globalPropertyDeleted(String propertyName)

Description copied from interface: GlobalPropertyListener

Called after a global property is deleted

Specified by:

globalPropertyDeleted in interface GlobalPropertyListener

Parameters:

propertyName - the name of the property that was just deleted