org.openmrs.web.dwr

Class PersonListItem

java.lang.Object

org.openmrs.web.dwr.PersonListItem

Direct Known Subclasses:

PatientListItem, UserListItem

public class PersonListItem
extends java.lang.Object

A mini/simplified Person object. Used as the return object from DWR methods to allow javascript and other consumers to easily use all methods. This class guarantees that all objects in this class will be initialized (copied) off of the Person object.

See Also:

Person, DWRPersonService

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PersonListItem() Default empty constructor
PersonListItem(java.lang.Integer personId) Convenience constructor to create a PersonListItem that has only this personId
PersonListItem(Person person) Convenience constructor that creates a PersonListItem from the given Person.
PersonListItem(Person person, java.lang.String searchName) Convenience constructor that creates a PersonListItem from the given Person.

Method Summary

Modifier and Type	Method and Description
static PersonListItem	createBestMatch(Person person) Creates an instance of a subclass of PersonListItem which is best suited for the parameter.
boolean	equals(java.lang.Object obj)
java.lang.String	getAddress1()
java.lang.String	getAddress2()
java.lang.Integer	getAge()
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
java.util.Date	getBirthdate()
java.lang.Boolean	getBirthdateEstimated()
java.lang.String	getBirthdateString() Returns a formatted birthdate value
java.lang.String	getFamilyName()
java.lang.String	getGender()
java.lang.String	getGivenName()
java.lang.String	getMiddleName()
java.lang.String	getOtherNames()
java.lang.Integer	getPersonId()
java.lang.String	getPersonName() Convenience method to retrieve the givenName middleName familyName
java.lang.String	getUuid()
java.lang.Boolean	getVoided()
int	hashCode()
void	setAddress1(java.lang.String address1)
void	setAddress2(java.lang.String address2)
void	setBirthdate(java.util.Date birthdate)
void	setBirthdateEstimated(java.lang.Boolean birthdateEstimated)
void	setBirthdateString(java.lang.String birthdateString)
void	setFamilyName(java.lang.String familyName)
void	setGender(java.lang.String gender)
void	setGivenName(java.lang.String givenName)
void	setMiddleName(java.lang.String middleName)
void	setOtherNames(java.lang.String otherNames)
void	setPersonId(java.lang.Integer personId)
void	setVoided(java.lang.Boolean voided)

Methods inherited from class java.lang.Object

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

Field Detail

log

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

Constructor Detail

PersonListItem

public PersonListItem()

Default empty constructor

PersonListItem

public PersonListItem(java.lang.Integer personId)

Convenience constructor to create a PersonListItem that has only this personId

Parameters:

personId - the person id to assign

PersonListItem

public PersonListItem(Person person)

Convenience constructor that creates a PersonListItem from the given Person. All relevant attributes are pulled off of the Person object and copied to this PersonListItem

Parameters:

person - the Person to turn into a PersonListItem

PersonListItem

public PersonListItem(Person person,
                      java.lang.String searchName)

Convenience constructor that creates a PersonListItem from the given Person. All relevant attributes are pulled off of the Person object and copied to this PersonListItem. And set the best match name based on the search criteria.

Parameters:

person - the Person to turn into a PersonListItem

searchName - Search query string of the name

Method Detail

createBestMatch

public static PersonListItem createBestMatch(Person person)

Creates an instance of a subclass of PersonListItem which is best suited for the parameter. If a Patient is passed in, a PatientListItem is returned, otherwise a PersonListItem is returned.

Parameters:

person - the Person object to covert to a PersonListItem

Returns:

a PersonListItem or subclass thereof

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

getBirthdate

public java.util.Date getBirthdate()

setBirthdate

public void setBirthdate(java.util.Date birthdate)

getBirthdateString

public java.lang.String getBirthdateString()

Returns a formatted birthdate value

Since:

1.8

setBirthdateString

public void setBirthdateString(java.lang.String birthdateString)

Since:

1.8

getBirthdateEstimated

public java.lang.Boolean getBirthdateEstimated()

setBirthdateEstimated

public void setBirthdateEstimated(java.lang.Boolean birthdateEstimated)

getFamilyName

public java.lang.String getFamilyName()

setFamilyName

public void setFamilyName(java.lang.String familyName)

getMiddleName

public java.lang.String getMiddleName()

setMiddleName

public void setMiddleName(java.lang.String middleName)

getGender

public java.lang.String getGender()

setGender

public void setGender(java.lang.String gender)

getGivenName

public java.lang.String getGivenName()

setGivenName

public void setGivenName(java.lang.String givenName)

getPersonName

public java.lang.String getPersonName()

Convenience method to retrieve the givenName middleName familyName

Returns:

String this person's name

getAddress1

public java.lang.String getAddress1()

setAddress1

public void setAddress1(java.lang.String address1)

getAddress2

public java.lang.String getAddress2()

setAddress2

public void setAddress2(java.lang.String address2)

getVoided

public java.lang.Boolean getVoided()

setVoided

public void setVoided(java.lang.Boolean voided)

getOtherNames

public java.lang.String getOtherNames()

setOtherNames

public void setOtherNames(java.lang.String otherNames)

getAge

public java.lang.Integer getAge()

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

getPersonId

public java.lang.Integer getPersonId()

Returns:

the personId

setPersonId

public void setPersonId(java.lang.Integer personId)

Parameters:

personId - the personId to set

getUuid

public java.lang.String getUuid()