org.openmrs.web.dwr

Class DWRPersonService

java.lang.Object

org.openmrs.web.dwr.DWRPersonService

public class DWRPersonService
extends Object

DWR methods for ajaxy effects on Person objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
DWRPersonService()

Method Summary

Modifier and Type	Method and Description
Object	createPerson(String given, String middle, String family, String birthdate, String dateformat, String age, String gender) Creates a new person stub.
Vector<Object>	findBatchOfPeopleByRoles(String searchPhrase, boolean includeRetired, String roles, Integer start, Integer length) Find Person objects based on the given searchPhrase
Map<String,Object>	findCountAndPeople(String phrase, boolean includeRetired, String roles, 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 people (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.
List<?>	findPeople(String searchPhrase, boolean includeVoided)
List<Object>	findPeopleByRoles(String searchPhrase, boolean includeVoided, String roles) Find Person objects based on the given searchPhrase
PersonListItem	getPerson(Integer personId)
List<?>	getSimilarPeople(String name, String birthdate, String age, String gender) Searches for Person records that have a name similar to the given name, a birthdate that is null or within a few years of the given birthdate, and a gender that matches.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

DWRPersonService

public DWRPersonService()

Method Detail

getSimilarPeople

public List<?> getSimilarPeople(String name,
                                String birthdate,
                                String age,
                                String gender)

Searches for Person records that have a name similar to the given name, a birthdate that is null or within a few years of the given birthdate, and a gender that matches. Note: this method contains a non-backwards-compatible change between 1.5 and 1.6, since DWR has trouble with method overloading. The String personType parameter was removed, since User no longer extends Person

Parameters:

name -

birthdate -

age -

gender -

Returns:

list of people

findPeople

public List<?> findPeople(String searchPhrase,
                          boolean includeVoided)

Parameters:

searchPhrase -

includeVoided -

Returns:

list of people

findPeopleByRoles

public List<Object> findPeopleByRoles(String searchPhrase,
                                      boolean includeVoided,
                                      String roles)

Find Person objects based on the given searchPhrase

Parameters:

searchPhrase - partial name or partial identifier

includeVoided - true/false whether to include the voided objects

roles - if not null, restricts search to only users and only users with these roles

Returns:

list of PersonListItem s that match the given searchPhrase. The PersonListItems contain as much information as possible about the matching persons, e.g. considering whether they are patients or users, which for example is useful for displaying patient identifiers in PersonSearch-widgets.

Expected Behavior:

Should match on patient identifiers

Should allow null roles parameter

createPerson

public Object createPerson(String given,
                           String middle,
                           String family,
                           String birthdate,
                           String dateformat,
                           String age,
                           String gender)

Creates a new person stub.

Parameters:

given -

middle -

family -

birthdate -

dateformat -

age -

gender -

Returns:

PersonListItem person stub created

getPerson

public PersonListItem getPerson(Integer personId)

Parameters:

personId -

Returns:

person or null

findBatchOfPeopleByRoles

public Vector<Object> findBatchOfPeopleByRoles(String searchPhrase,
                                               boolean includeRetired,
                                               String roles,
                                               Integer start,
                                               Integer length)

Find Person objects based on the given searchPhrase

Parameters:

searchPhrase - partial name or partial identifier

includeRetired - true/false whether to include the voided objects

roles - if not null, restricts search to only users and only users with these roles

start - the beginning index (this is only used for user search i.e of roles are specified)

length - the number of matching people to return (this is only used for user search i.e of roles are specified)

Returns:

list of persons that match the given searchPhrase. The PersonListItems

Since:

1.8

findCountAndPeople

public Map<String,Object> findCountAndPeople(String phrase,
                                             boolean includeRetired,
                                             String roles,
                                             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 people (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 people

includeRetired - Specifies if retired people should be included or not

roles - If not null, restricts search to only users and only users with these roles

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