PersonName (OpenMRS 1.8.5-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsData
  - - org.openmrs.PersonName

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PersonName>, Auditable, OpenmrsData, OpenmrsObject, Voidable
```
public class PersonName
extends BaseOpenmrsData
implements Serializable, Cloneable, Comparable<PersonName>
```
A Person can have zero to n PersonName(s).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID
- Fields inherited from class org.openmrs.BaseOpenmrsData
  creator

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description
`PersonName()` default constructor
`PersonName(Integer personNameId)` constructor with id
`PersonName(String givenName, String middleName, String familyName)` Convenience constructor with the basic requirements

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(PersonName other)` TODO: the behavior of this method needs to be controlled by some sort of global property because an implementation can define how they want their names to look (which fields to show/hide)
`boolean`	`equals(Object obj)` Compares two objects for similarity
`boolean`	`equalsContent(PersonName otherName)` Compares this PersonName object to the given otherName.
`Date`	`getDateVoided()` This still exists on PersonName for the SimpleFramework annotation
`String`	`getDegree()`
`String`	`getFamilyName()`
`String`	`getFamilyName2()`
`String`	`getFamilyNamePrefix()`
`String`	`getFamilyNameSuffix()`
`String`	`getFullName()` Convenience method to get all the names of this PersonName and concatonating them together with spaces in between.
`String`	`getGivenName()`
`Integer`	`getId()`
`String`	`getMiddleName()`
`Person`	`getPerson()`
`Integer`	`getPersonNameId()`
`Boolean`	`getPreferred()`
`String`	`getPrefix()`
`Boolean`	`getVoided()` This method delegates to `BaseOpenmrsData.isVoided()`.
`User`	`getVoidedBy()` This still exists on PersonName for the SimpleFramework annotation
`String`	`getVoidReason()` This still exists on PersonName for the SimpleFramework annotation
`int`	`hashCode()`
`Boolean`	`isPreferred()`
`static PersonName`	`newInstance(PersonName pn)` bitwise copy of the personName object.
`void`	`setDateVoided(Date dateVoided)`
`void`	`setDegree(String degree)`
`void`	`setFamilyName(String familyName)`
`void`	`setFamilyName2(String familyName2)`
`void`	`setFamilyNamePrefix(String familyNamePrefix)`
`void`	`setFamilyNameSuffix(String familyNameSuffix)`
`void`	`setGivenName(String givenName)`
`void`	`setId(Integer id)`
`void`	`setMiddleName(String middleName)`
`void`	`setPerson(Person person)`
`void`	`setPersonNameId(Integer personNameId)`
`void`	`setPreferred(Boolean preferred)`
`void`	`setPrefix(String prefix)`
`void`	`setVoided(Boolean voided)` This still exists on PersonName for the SimpleFramework annotation
`void`	`setVoidedBy(User voidedBy)` This still exists on PersonName for the SimpleFramework annotation
`void`	`setVoidReason(String voidReason)` This still exists on PersonName for the SimpleFramework annotation
`String`	`toString()`

Methods inherited from class org.openmrs.BaseOpenmrsData
getChangedBy, getCreator, getDateChanged, getDateCreated, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated

Methods inherited from class org.openmrs.BaseOpenmrsObject
getUuid, setUuid

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject
getUuid, setUuid

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PersonName
```
public PersonName()
```
    default constructor
  - PersonName
```
public PersonName(Integer personNameId)
```
    constructor with id
  - PersonName
```
public PersonName(String givenName,
                  String middleName,
                  String familyName)
```
    Convenience constructor with the basic requirements
    
    Parameters:
    
    givenName - String this person's first name
    
    middleName - String this person's middle name
    
    familyName - String this person's last name
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Compares two objects for similarity
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - PersonName to compare to
    
    Returns:
    
    boolean true/false whether or not they are the same objects
    
    See Also:
    
    Object.equals(java.lang.Object)
    
    Should:
    
    not fail if either has a null person property, return false if this has a missing person property, return false if obj has a missing person property, return true if properties are equal and have null person
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - equalsContent
```
public boolean equalsContent(PersonName otherName)
```
    Compares this PersonName object to the given otherName. This method differs from equals(Object) in that this method compares the inner fields of each name for equality. Note: Null/empty fields on otherName /will not/ cause a false value to be returned
    
    Parameters:
    
    otherName - PersonName with which to compare
    
    Returns:
    
    boolean true/false whether or not they are the same names
    
    Should:
    
    return true if given middle and family name are equal
  - newInstance
```
public static PersonName newInstance(PersonName pn)
```
    bitwise copy of the personName object. NOTICE: THIS WILL NOT COPY THE PATIENT OBJECT. The PersonName.person object in this object AND the cloned object will point at the same person
    
    Returns:
    
    New PersonName object
    
    Should:
    
    copy every property of given personName
  - getDateVoided
```
public Date getDateVoided()
```
    This still exists on PersonName for the SimpleFramework annotation
    
    Specified by:
    
    getDateVoided in interface Voidable
    
    Overrides:
    
    getDateVoided in class BaseOpenmrsData
    
    Returns:
    
    Returns the dateVoided.
    
    See Also:
    
    Voidable.getDateVoided()
  - setDateVoided
```
public void setDateVoided(Date dateVoided)
```
    Specified by:
    
    setDateVoided in interface Voidable
    
    Overrides:
    
    setDateVoided in class BaseOpenmrsData
    
    Parameters:
    
    dateVoided - The dateVoided to set.
    
    See Also:
    
    Voidable.setDateVoided(java.util.Date)
  - getDegree
```
public String getDegree()
```
    Returns:
    
    Returns the degree.
  - setDegree
```
public void setDegree(String degree)
```
    Parameters:
    
    degree - The degree to set.
  - getFamilyName
```
public String getFamilyName()
```
    Returns:
    
    Returns the familyName.
    
    Should:
    
    return obscured name if obscure_patients is set to true
  - setFamilyName
```
public void setFamilyName(String familyName)
```
    Parameters:
    
    familyName - The familyName to set.
  - getFamilyName2
```
public String getFamilyName2()
```
    Returns:
    
    Returns the familyName2.
    
    Should:
    
    return null if obscure_patients is set to true
  - setFamilyName2
```
public void setFamilyName2(String familyName2)
```
    Parameters:
    
    familyName2 - The familyName2 to set.
  - getFamilyNamePrefix
```
public String getFamilyNamePrefix()
```
    Returns:
    
    Returns the familyNamePrefix.
    
    Should:
    
    return null if obscure_patients is set to true
  - setFamilyNamePrefix
```
public void setFamilyNamePrefix(String familyNamePrefix)
```
    Parameters:
    
    familyNamePrefix - The familyNamePrefix to set.
  - getFamilyNameSuffix
```
public String getFamilyNameSuffix()
```
    Returns:
    
    Returns the familyNameSuffix.
    
    Should:
    
    return null if obscure_patients is set to true
  - setFamilyNameSuffix
```
public void setFamilyNameSuffix(String familyNameSuffix)
```
    Parameters:
    
    familyNameSuffix - The familyNameSuffix to set.
  - getGivenName
```
public String getGivenName()
```
    Returns:
    
    Returns the givenName.
    
    Should:
    
    return obscured name if obscure_patients is set to true
  - setGivenName
```
public void setGivenName(String givenName)
```
    Parameters:
    
    givenName - The givenName to set.
  - getMiddleName
```
public String getMiddleName()
```
    Returns:
    
    Returns the middleName.
    
    Should:
    
    return obscured name if obscure_patients is set to true
  - setMiddleName
```
public void setMiddleName(String middleName)
```
    Parameters:
    
    middleName - The middleName to set.
  - getPerson
```
public Person getPerson()
```
    Returns:
    
    Returns the person.
  - setPerson
```
public void setPerson(Person person)
```
    Parameters:
    
    person - The person to set.
  - getPersonNameId
```
public Integer getPersonNameId()
```
    Returns:
    
    Returns the personNameId.
  - setPersonNameId
```
public void setPersonNameId(Integer personNameId)
```
    Parameters:
    
    personNameId - The personNameId to set.
  - isPreferred
```
public Boolean isPreferred()
```
    Returns:
    
    Returns the preferred.
  - getPreferred
```
public Boolean getPreferred()
```
  - setPreferred
```
public void setPreferred(Boolean preferred)
```
    Parameters:
    
    preferred - The preferred to set.
  - getPrefix
```
public String getPrefix()
```
    Returns:
    
    Returns the prefix.
    
    Should:
    
    return null if obscure_patients is set to true
  - setPrefix
```
public void setPrefix(String prefix)
```
    Parameters:
    
    prefix - The prefix to set.
  - getVoided
```
public Boolean getVoided()
```
    Description copied from class: BaseOpenmrsData
    
    This method delegates to BaseOpenmrsData.isVoided(). This is only needed for jstl syntax like ${person.voided} because the return type is a Boolean object instead of a boolean primitive type.
    
    Overrides:
    
    getVoided in class BaseOpenmrsData
    
    See Also:
    
    BaseOpenmrsData.isVoided()
  - setVoided
```
public void setVoided(Boolean voided)
```
    This still exists on PersonName for the SimpleFramework annotation
    
    Specified by:
    
    setVoided in interface Voidable
    
    Overrides:
    
    setVoided in class BaseOpenmrsData
    
    Parameters:
    
    voided - The voided to set.
    
    See Also:
    
    Voidable.setVoided(java.lang.Boolean)
  - getVoidedBy
```
public User getVoidedBy()
```
    This still exists on PersonName for the SimpleFramework annotation
    
    Specified by:
    
    getVoidedBy in interface Voidable
    
    Overrides:
    
    getVoidedBy in class BaseOpenmrsData
    
    Returns:
    
    Returns the voidedBy.
    
    See Also:
    
    Voidable.getVoidedBy()
  - setVoidedBy
```
public void setVoidedBy(User voidedBy)
```
    This still exists on PersonName for the SimpleFramework annotation
    
    Specified by:
    
    setVoidedBy in interface Voidable
    
    Overrides:
    
    setVoidedBy in class BaseOpenmrsData
    
    Parameters:
    
    voidedBy - The voidedBy to set.
    
    See Also:
    
    Voidable.setVoidedBy(org.openmrs.User)
  - getVoidReason
```
public String getVoidReason()
```
    This still exists on PersonName for the SimpleFramework annotation
    
    Specified by:
    
    getVoidReason in interface Voidable
    
    Overrides:
    
    getVoidReason in class BaseOpenmrsData
    
    Returns:
    
    Returns the voidReason.
    
    See Also:
    
    Voidable.getVoidReason()
  - setVoidReason
```
public void setVoidReason(String voidReason)
```
    This still exists on PersonName for the SimpleFramework annotation
    
    Specified by:
    
    setVoidReason in interface Voidable
    
    Overrides:
    
    setVoidReason in class BaseOpenmrsData
    
    Parameters:
    
    voidReason - The voidReason to set.
    
    See Also:
    
    Voidable.setVoidReason(java.lang.String)
  - getFullName
```
public String getFullName()
```
    Convenience method to get all the names of this PersonName and concatonating them together with spaces in between. If any part of getPrefix(), getGivenName(), getMiddleName(), etc are null, they are not included in the returned name
    
    Returns:
    
    all of the parts of this PersonName joined with spaces
    
    Should:
    
    not put spaces around an empty middle name
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - compareTo
```
public int compareTo(PersonName other)
```
    TODO: the behavior of this method needs to be controlled by some sort of global property because an implementation can define how they want their names to look (which fields to show/hide)
    
    Specified by:
    
    compareTo in interface Comparable<PersonName>
    
    See Also:
    
    Comparable.compareTo(java.lang.Object)
    
    Should:
    
    return negative if other name is voided, return negative if this name is preferred, return negative if other familyName is greater, return negative if other familyName2 is greater, return negative if other givenName is greater, return negative if other middleName is greater, return negative if other familynamePrefix is greater, return negative if other familyNameSuffix is greater, return negative if other dateCreated is greater
  - getId
```
public Integer getId()
```
    Specified by:
    
    getId in interface OpenmrsObject
    
    Returns:
    
    id - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.getId()
  - setId
```
public void setId(Integer id)
```
    Specified by:
    
    setId in interface OpenmrsObject
    
    Parameters:
    
    id - - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.setId(java.lang.Integer)

Class PersonName

Field Summary

Fields inherited from class org.openmrs.BaseOpenmrsData

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseOpenmrsData

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.OpenmrsObject

Field Detail

serialVersionUID

Constructor Detail

PersonName

PersonName

PersonName

Method Detail

equals

hashCode

equalsContent

newInstance

getDateVoided

setDateVoided

getDegree

setDegree

getFamilyName

setFamilyName

getFamilyName2

setFamilyName2

getFamilyNamePrefix

setFamilyNamePrefix

getFamilyNameSuffix

setFamilyNameSuffix

getGivenName

setGivenName

getMiddleName

setMiddleName

getPerson

setPerson

getPersonNameId

setPersonNameId

isPreferred

getPreferred

setPreferred

getPrefix

setPrefix

getVoided

setVoided

getVoidedBy

setVoidedBy

getVoidReason

setVoidReason

getFullName

toString

compareTo

getId

setId