PersonListItem (OpenMRS 2.0.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.web.dwr.PersonListItem

Direct Known Subclasses:

PatientListItem, UserListItem
```
public class PersonListItem
extends 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

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(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, String searchName)` Convenience constructor that creates a PersonListItem from the given Person.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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(Object obj)`
`String`	`getAddress1()`
`String`	`getAddress2()`
`Integer`	`getAge()`
`Map<String,String>`	`getAttributes()`
`Date`	`getBirthdate()`
`Boolean`	`getBirthdateEstimated()`
`String`	`getBirthdateString()` Returns a formatted birthdate value
`Boolean`	`getDeathdateEstimated()`
`String`	`getDeathDateString()`
`String`	`getFamilyName()`
`String`	`getGender()`
`String`	`getGivenName()`
`String`	`getMiddleName()`
`String`	`getOtherNames()`
`Integer`	`getPersonId()`
`String`	`getPersonName()` Convenience method to retrieve the givenName middleName familyName
`String`	`getUuid()`
`Boolean`	`getVoided()`
`int`	`hashCode()`
`void`	`setAddress1(String address1)`
`void`	`setAddress2(String address2)`
`void`	`setBirthdate(Date birthdate)`
`void`	`setBirthdateEstimated(Boolean birthdateEstimated)`
`void`	`setBirthdateString(String birthdateString)`
`void`	`setDeathdateEstimated(Boolean deathdateEstimated)`
`void`	`setDeathDateString(String deathDateString)`
`void`	`setFamilyName(String familyName)`
`void`	`setGender(String gender)`
`void`	`setGivenName(String givenName)`
`void`	`setMiddleName(String middleName)`
`void`	`setOtherNames(String otherNames)`
`void`	`setPersonId(Integer personId)`
`void`	`setVoided(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(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
    
    Expected Behavior:
    
    Should put attribute toString value into attributes map
  - PersonListItem
```
public PersonListItem(Person person,
                      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
    
    Expected Behavior:
    
    Should identify best matching name for the family name
    
    Should identify best matching name as preferred name even if other names match
    
    Should identify best matching name as other name for the middle name
    
    Should identify best matching name as other name for the given name
    
    Should identify best matching name in multiple search names
- 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
    
    Expected Behavior:
    
    Should return PatientListItem given patient parameter
    
    Should return PersonListItem given person parameter
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - getBirthdate
```
public Date getBirthdate()
```
  - setBirthdate
```
public void setBirthdate(Date birthdate)
```
  - getBirthdateString
```
public String getBirthdateString()
```
    Returns a formatted birthdate value
    
    Since:
    
    1.8
  - setBirthdateString
```
public void setBirthdateString(String birthdateString)
```
    Since:
    
    1.8
  - getBirthdateEstimated
```
public Boolean getBirthdateEstimated()
```
  - setBirthdateEstimated
```
public void setBirthdateEstimated(Boolean birthdateEstimated)
```
  - getDeathDateString
```
public String getDeathDateString()
```
  - setDeathDateString
```
public void setDeathDateString(String deathDateString)
```
  - getDeathdateEstimated
```
public Boolean getDeathdateEstimated()
```
  - setDeathdateEstimated
```
public void setDeathdateEstimated(Boolean deathdateEstimated)
```
  - getFamilyName
```
public String getFamilyName()
```
  - setFamilyName
```
public void setFamilyName(String familyName)
```
  - getMiddleName
```
public String getMiddleName()
```
  - setMiddleName
```
public void setMiddleName(String middleName)
```
  - getGender
```
public String getGender()
```
  - setGender
```
public void setGender(String gender)
```
  - getGivenName
```
public String getGivenName()
```
  - setGivenName
```
public void setGivenName(String givenName)
```
  - getPersonName
```
public String getPersonName()
```
    Convenience method to retrieve the givenName middleName familyName
    
    Returns:
    
    String this person's name
  - getAddress1
```
public String getAddress1()
```
  - setAddress1
```
public void setAddress1(String address1)
```
  - getAddress2
```
public String getAddress2()
```
  - setAddress2
```
public void setAddress2(String address2)
```
  - getVoided
```
public Boolean getVoided()
```
  - setVoided
```
public void setVoided(Boolean voided)
```
  - getOtherNames
```
public String getOtherNames()
```
  - setOtherNames
```
public void setOtherNames(String otherNames)
```
  - getAge
```
public Integer getAge()
```
  - getAttributes
```
public Map<String,String> getAttributes()
```
  - getPersonId
```
public Integer getPersonId()
```
    Returns:
    
    the personId
  - setPersonId
```
public void setPersonId(Integer personId)
```
    Parameters:
    
    personId - the personId to set
  - getUuid
```
public String getUuid()
```

Class PersonListItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

Constructor Detail

PersonListItem

PersonListItem

PersonListItem

PersonListItem

Method Detail

createBestMatch

equals

hashCode

getBirthdate

setBirthdate

getBirthdateString

setBirthdateString

getBirthdateEstimated

setBirthdateEstimated

getDeathDateString

setDeathDateString

getDeathdateEstimated

setDeathdateEstimated

getFamilyName

setFamilyName

getMiddleName

setMiddleName

getGender

setGender

getGivenName

setGivenName

getPersonName

getAddress1

setAddress1

getAddress2

setAddress2

getVoided

setVoided

getOtherNames

setOtherNames

getAge

getAttributes

getPersonId

setPersonId

getUuid