org.openmrs.web.dwr

Class DWREncounterService

java.lang.Object

org.openmrs.web.dwr.DWREncounterService

public class DWREncounterService
extends Object

Constructor Summary

Constructors

Constructor and Description
DWREncounterService()

Method Summary

Modifier and Type	Method and Description
Vector	findBatchOfEncounters(String phrase, boolean includeVoided, Integer start, Integer length) Returns a list of matching encounters (depending on values of start and length parameters) if the length parameter is not specified, then all matches will be returned from the start index if specified.
Vector	findBatchOfEncountersByPatient(String phrase, Integer patientId, boolean includeVoided, Integer start, Integer length) Returns a list of matching encounters (depending on values of start and length parameters) if the length parameter is not specified, then all matches will be returned from the start index if specified.
Vector<Object>	findBatchOfLocations(String searchValue, boolean includeRetired, Integer start, Integer length) Returns a list of matching locations (depending on values of start and length parameters) if the length parameter is not specified, then all matches will be returned from the start index if specified.
Map<String,Object>	findCountAndEncounters(String phrase, boolean includeVoided, 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 encounters (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>	findCountAndLocations(String phrase, boolean includeRetired, 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 locations (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	findEncounters(String phrase, boolean includeVoided) Returns a list of encounters for patients with a matching name, identifier or encounterId if phrase is a number.
Vector	findLocations(String searchValue)
EncounterListItem	getEncounter(Integer encounterId)
LocationListItem	getLocation(Integer locationId)
Vector	getLocations()

Methods inherited from class java.lang.Object

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

Constructor Detail

DWREncounterService

public DWREncounterService()

Method Detail

findEncounters

public Vector findEncounters(String phrase,
                             boolean includeVoided)
                      throws APIException

Returns a list of encounters for patients with a matching name, identifier or encounterId if phrase is a number.

Parameters:

phrase - patient name or identifier

includeVoided - Specifies if voided encounters should be included or not

Returns:

list of the matching encounters

Throws:

APIException

findBatchOfEncounters

public Vector findBatchOfEncounters(String phrase,
                                    boolean includeVoided,
                                    Integer start,
                                    Integer length)
                             throws APIException

Returns a list of matching encounters (depending on values of start and length parameters) if the length parameter is not specified, then all matches will be returned from the start index if specified.

Parameters:

phrase - patient name or identifier

includeVoided - Specifies if voided encounters should be included or not

start - the beginning index

length - the number of matching encounters to return

Returns:

list of the matching encounters

Throws:

APIException

Since:

1.8

findBatchOfEncountersByPatient

public Vector findBatchOfEncountersByPatient(String phrase,
                                             Integer patientId,
                                             boolean includeVoided,
                                             Integer start,
                                             Integer length)
                                      throws APIException

Returns a list of matching encounters (depending on values of start and length parameters) if the length parameter is not specified, then all matches will be returned from the start index if specified.

Parameters:

phrase - encounter id, provider identifier, location, encounter type, provider, form or provider name

patientId - the patient id

includeVoided - Specifies if voided encounters should be included or not

start - the beginning index

length - the number of matching encounters to return

Returns:

list of the matching encounters

Throws:

APIException

Since:

1.10

findCountAndEncounters

public Map<String,Object> findCountAndEncounters(String phrase,
                                                 boolean includeVoided,
                                                 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 encounters (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:

phrase - patient name or identifier

includeVoided - Specifies if voided encounters should be included or not

start - the beginning index

length - the number of matching encounters to return

Returns:

a map of results

Throws:

APIException

Since:

1.8

getEncounter

public EncounterListItem getEncounter(Integer encounterId)

findLocations

public Vector findLocations(String searchValue)

findBatchOfLocations

public Vector<Object> findBatchOfLocations(String searchValue,
                                           boolean includeRetired,
                                           Integer start,
                                           Integer length)
                                    throws APIException

Returns a list of matching locations (depending on values of start and length parameters) if the length parameter is not specified, then all matches will be returned from the start index if specified.

Parameters:

searchValue - is the string used to search for locations

includeRetired - Specifies if retired locations should be returned

start - the beginning index

length - the number of matching locations to return

Returns:

list of the matching locations

Throws:

APIException

Since:

1.8

getLocations

public Vector getLocations()

getLocation

public LocationListItem getLocation(Integer locationId)

findCountAndLocations

public Map<String,Object> findCountAndLocations(String phrase,
                                                boolean includeRetired,
                                                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 locations (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:

phrase - is the string used to search for locations

includeRetired - Specifies if retired locations should be returned

start - the beginning index

length - the number of matching encounters 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