org.openmrs.api

Interface PersonService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

PersonServiceImpl

public interface PersonService
extends OpenmrsService

Contains methods pertaining to Persons in the system Use:

 
 
 
 
 List<Person> personObjects = Context.getPersonService().getAllPersons();
 

See Also:

Context, Patient

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PersonService.ATTR_VIEW_TYPE These enumerations are used when determining which person attr types to display.

Method Summary

Modifier and Type	Method and Description
void	checkIfPersonAttributeTypesAreLocked() Check if the person attribute types are locked, and if they are throws an exception during manipulation of a person attribute type
List<PersonAttributeType>	getAllPersonAttributeTypes() Get all PersonAttributeTypes in the database
List<PersonAttributeType>	getAllPersonAttributeTypes(boolean includeRetired) Get all PersonAttributeTypes in the database with the option of including the retired types
List<PersonMergeLog>	getAllPersonMergeLogs(boolean deserialize) Gets all the PersonMergeLog objects from the model
List<Relationship>	getAllRelationships() Get list of relationships that are not voided
List<Relationship>	getAllRelationships(boolean includeVoided) Get list of relationships optionally including the voided ones or not
List<RelationshipType>	getAllRelationshipTypes() Get all relationshipTypes Includes retired relationship types
List<RelationshipType>	getAllRelationshipTypes(boolean includeRetired) Get all relationshipTypes with the option of including the retired types
PersonMergeLog	getLosingPersonMergeLog(Person person, boolean deserialize) Gets the PersonMergeLog where person p is the loser.
List<Person>	getPeople(String searchPhrase, Boolean dead) Find a person matching the searchPhrase search string
List<Person>	getPeople(String searchPhrase, Boolean dead, Boolean voided)
Person	getPerson(Integer personId) Gets a person by internal id
PersonAddress	getPersonAddressByUuid(String uuid) Get PersonAddress by its UUID
PersonAttribute	getPersonAttribute(Integer id) Get a PersonAttribute from the database with the given PersonAttributeid
PersonAttribute	getPersonAttributeByUuid(String uuid) Get PersonAttribute by its UUID
PersonAttributeType	getPersonAttributeType(Integer typeId) Get the PersonAttributeType given the type's PersonAttributeTypeId
PersonAttributeType	getPersonAttributeTypeByName(String typeName) Get the PersonAttributeType given the type's name
PersonAttributeType	getPersonAttributeTypeByUuid(String uuid) Gets a person attribute type with the given uuid.
List<PersonAttributeType>	getPersonAttributeTypes(OpenmrsConstants.PERSON_TYPE personType, PersonService.ATTR_VIEW_TYPE viewType) Gets the types defined for the given person type (person, user, patient) and the given type of view (one person vs many person objects)
List<PersonAttributeType>	getPersonAttributeTypes(String exactName, String format, Integer foreignKey, Boolean searchable) Find person attribute types matching the given parameters.
Person	getPersonByUuid(String uuid) Get Person by its UUID
PersonMergeLog	getPersonMergeLogByUuid(String uuid, boolean deserialize) Gets a PersonMergeLog object from the model using the UUID identifier.
PersonName	getPersonName(Integer personNameId) Get PersonName by its personNameId
PersonName	getPersonNameByUuid(String uuid) Get PersonName by its UUID
Relationship	getRelationship(Integer relationshipId) Get relationship by internal relationship identifier
Relationship	getRelationshipByUuid(String uuid) Get Relationship by its UUID
Map<Person,List<Person>>	getRelationshipMap(RelationshipType relationshipType) Get all relationships for a given type of relationship mapped from the personA to all of the personB's
List<Relationship>	getRelationships(Person fromPerson, Person toPerson, RelationshipType relType) Get relationships stored in the database that
List<Relationship>	getRelationships(Person fromPerson, Person toPerson, RelationshipType relType, Date effectiveDate) Get relationships stored in the database that are active on the passed date
List<Relationship>	getRelationships(Person fromPerson, Person toPerson, RelationshipType relType, Date startEffectiveDate, Date endEffectiveDate) Get relationships stored in the database that were active during the specified date range
List<Relationship>	getRelationshipsByPerson(Person p) Get list of relationships that include Person in person_id or relative_id Does not include voided relationships
List<Relationship>	getRelationshipsByPerson(Person p, Date effectiveDate) Get list of relationships that include Person in person_id or relative_id.
RelationshipType	getRelationshipType(Integer relationshipTypeId) Get relationshipType by internal identifier
RelationshipType	getRelationshipTypeByName(String relationshipTypeName) Find relationshipType by exact name match
RelationshipType	getRelationshipTypeByUuid(String uuid) Gets the relationship type with the given uuid.
List<RelationshipType>	getRelationshipTypes(String searchString) Get relationshipTypes by searching through the names and loosely matching to the given searchString
List<RelationshipType>	getRelationshipTypes(String relationshipTypeName, Boolean preferred) Find relationshipTypes by exact name match and/or preferred status
Set<Person>	getSimilarPeople(String nameSearch, Integer birthyear, String gender) Find a similar person given the attributes.
List<PersonMergeLog>	getWinningPersonMergeLogs(Person person, boolean deserialize) Gets PersonMergeLog objects by winning person p.
PersonName	parsePersonName(String name) Parses a name into a PersonName (separate Given, Middle, and Family names)
void	purgePerson(Person person) Purges a person from the database (cannot be undone)
void	purgePersonAttributeType(PersonAttributeType type) Purges a PersonAttribute type from the database (cannot be undone)
void	purgeRelationship(Relationship relationship) Purges a relationship from the database (cannot be undone)
void	purgeRelationshipType(RelationshipType relationshipType) Purge relationship type from the database (cannot be undone)
PersonAttributeType	retirePersonAttributeType(PersonAttributeType type, String retiredReason) Retire a Person Attribute Type
RelationshipType	retireRelationshipType(RelationshipType type, String retiredReason) Retire a Person Relationship Type
Person	savePerson(Person person) Creates or updates a Person in the database
PersonAddress	savePersonAddress(PersonAddress personAddress) Inserts or updates the given personAddress object in the database
PersonAttributeType	savePersonAttributeType(PersonAttributeType type) Save the given person attribute type in the database.
PersonMergeLog	savePersonMergeLog(PersonMergeLog personMergeLog) Builds the serialized data from PersonMergeLog.getPersonMergeLogData(), sets the mergedData String, and the creator and date if null.
PersonName	savePersonName(PersonName personName) Inserts or updates the given personName object in the database
Relationship	saveRelationship(Relationship relationship) Create or update a relationship between people.
RelationshipType	saveRelationshipType(RelationshipType relationshipType) Inserts or updates the given relationship type object in the database
void	setPersonDAO(PersonDAO dao) Sets the DAO for this service.
void	unretirePersonAttributeType(PersonAttributeType type) Unretires a PersonAttribute type from the database (can be undone)
RelationshipType	unretireRelationshipType(RelationshipType relationshipType) Unretire a Person Relationship Type
Person	unvoidPerson(Person person) Effectively resurrects this person in the db.
PersonAddress	unvoidPersonAddress(PersonAddress personAddress) Unvoid PersonAddress in the database, effectively marking this as a valid PersonAddress again
PersonName	unvoidPersonName(PersonName personName) Unvoid PersonName in the database, effectively marking this as a valid personName again
Relationship	unvoidRelationship(Relationship relationship) Unvoid Relationship in the database, effectively marking this as a valid relationship again
Person	voidPerson(Person person, String reason) Effectively removes this person from the system.
PersonAddress	voidPersonAddress(PersonAddress personAddress, String voidReason) Voids the given PersonAddress, effectively deleting the personAddress, from the end-user's point of view.
PersonName	voidPersonName(PersonName personName, String voidReason) Voids the given PersonName, effectively deleting the name, from the end-user's point of view.
Relationship	voidRelationship(Relationship relationship, String voidReason) Voids the given Relationship, effectively removing it from openmrs.

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

setPersonDAO

void setPersonDAO(PersonDAO dao)

Sets the DAO for this service. This is done through spring injection

Parameters:

dao - DAO for this service

getSimilarPeople

@Authorized(value="Get People")
Set<Person> getSimilarPeople(String nameSearch,
                                                             Integer birthyear,
                                                             String gender)
                                                      throws APIException

Find a similar person given the attributes. This does a very loose lookup with the nameSearch parameter. This does a very loose lookup on birthyear as well. Any person with a null/missing birthdate is included and anyone with a birthyear plus/minus one year from the given birthyear is also included

Parameters:

nameSearch - string to search the person's name for

birthyear - the year of birth to restrict

gender - The gender field to search on (Typically just "M" or "F")

Returns:

Set<Person> object with all people matching criteria

Throws:

APIException - Should accept greater than three names Should match single search to any name part Should match two word search to any name part Should match three word search to any name part Should match search to familyName2

getPeople

@Authorized(value="Get People")
List<Person> getPeople(String searchPhrase,
                                                       Boolean dead)
                                                throws APIException

Find a person matching the searchPhrase search string

Parameters:

searchPhrase - person name to match on

dead - if true will return only dead patients, if false will return only alive patients, if null will return both

Returns:

list of person objects matches the parameters Should match search to familyName2

Throws:

APIException

getPeople

@Authorized(value="Get People")
List<Person> getPeople(String searchPhrase,
                                                       Boolean dead,
                                                       Boolean voided)
                                                throws APIException

Throws:

APIException

savePersonAttributeType

@Authorized(value="Manage Person Attribute Types")
PersonAttributeType savePersonAttributeType(PersonAttributeType type)
                                                                                        throws APIException

Save the given person attribute type in the database.
If the given type's Id is not empty, then also need to change any global property which is in OpenmrsConstants.GLOBAL_PROPERTIES_OF_PERSON_ATTRIBUTES and reference this given type, prior to saving this given type.

Parameters:

type -

Returns:

the saved person attribute type

Throws:

APIException - Should set the date created and creator on new Should set the date changed and changed by on update Should update any global property which reference this type Should throw an error when trying to save person attribute type while person attribute types are locked

retirePersonAttributeType

@Authorized(value="Manage Person Attribute Types")
PersonAttributeType retirePersonAttributeType(PersonAttributeType type,
                                                                                                 String retiredReason)
                                                                                          throws APIException

Retire a Person Attribute Type

Parameters:

type -

retiredReason - Should throw an error when trying to retire person attribute type while person attribute types are locked

Throws:

APIException

retireRelationshipType

@Authorized(value="Manage Relationship Types")
RelationshipType retireRelationshipType(RelationshipType type,
                                                                                       String retiredReason)
                                                                                throws APIException

Retire a Person Relationship Type

Parameters:

type -

retiredReason -

Throws:

APIException

unretireRelationshipType

@Authorized(value="Manage Relationship Types")
RelationshipType unretireRelationshipType(RelationshipType relationshipType)

Unretire a Person Relationship Type

Parameters:

relationshipType - retiredReason

Since:

1.9

purgePersonAttributeType

@Authorized(value="Purge Person Attribute Types")
void purgePersonAttributeType(PersonAttributeType type)
                                                                         throws APIException

Purges a PersonAttribute type from the database (cannot be undone)

Parameters:

type - type to be purged from the database

Throws:

APIException - Should delete person attribute type from database Should throw an error when trying to delete person attribute type while person attribute types are locked

unretirePersonAttributeType

@Authorized(value="Manage Person Attribute Types")
void unretirePersonAttributeType(PersonAttributeType type)
                                                                             throws APIException

Unretires a PersonAttribute type from the database (can be undone)

Parameters:

type - type to be restored from the database

Throws:

APIException - Should restore person attribute type from database Should throw an error when trying to unretire person attribute type while person attribute types are locked

voidPerson

@Authorized(value="Edit People")
Person voidPerson(Person person,
                                                   String reason)
                                            throws APIException

Effectively removes this person from the system. Voids Patient and retires Users as well.

Parameters:

person - person to be voided

reason - reason for voiding person

Returns:

the person that was voided Should return voided person with given reason Should void patient Should retire users

Throws:

APIException

unvoidPerson

@Authorized(value="Edit People")
Person unvoidPerson(Person person)
                                              throws APIException

Effectively resurrects this person in the db. Unvoids Patient as well.

Parameters:

person - person to be revived

Returns:

the person that was unvoided Should unvoid the given person Should unvoid patient Should not unretire users

Throws:

APIException

getAllPersonAttributeTypes

@Authorized(value="Get Person Attribute Types")
List<PersonAttributeType> getAllPersonAttributeTypes()
                                                                                              throws APIException

Get all PersonAttributeTypes in the database

Returns:

All person attribute types including the retired ones Should return all person attribute types including retired

Throws:

APIException

See Also:

getAllPersonAttributeTypes(boolean)

getAllPersonAttributeTypes

@Authorized(value="Get Person Attribute Types")
List<PersonAttributeType> getAllPersonAttributeTypes(boolean includeRetired)
                                                                                              throws APIException

Get all PersonAttributeTypes in the database with the option of including the retired types

Parameters:

includeRetired - boolean - include retired attribute types as well?

Returns:

List<PersonAttributeType> object of all PersonAttributeTypes, possibly including retired ones Should return all person attribute types including retired when include retired is true Should return all person attribute types excluding retired when include retired is false

Throws:

APIException

getPersonAttributeTypes

@Authorized(value="Get Person Attribute Types")
List<PersonAttributeType> getPersonAttributeTypes(String exactName,
                                                                                                  String format,
                                                                                                  Integer foreignKey,
                                                                                                  Boolean searchable)
                                                                                           throws APIException

Find person attribute types matching the given parameters. Retired types are included in the results

Parameters:

exactName - (optional) The name of type

format - (optional) The format for this type

foreignKey - (optional) The foreign key

searchable - (optional) if true only returns searchable types, if false returns only nonsearchable and if null returns all

Returns:

list of PersonAttributeTypes matching the given parameters

Throws:

APIException - Should return person attribute types matching given parameters Should return empty list when no person attribute types match given parameters

getPersonAttributeType

@Authorized(value="Get Person Attribute Types")
PersonAttributeType getPersonAttributeType(Integer typeId)
                                                                                    throws APIException

Get the PersonAttributeType given the type's PersonAttributeTypeId

Parameters:

typeId - PersonAttributeType.personAttributeTypeId to match on

Returns:

the type matching this id or null if none was found Should return null when no person attribute with the given id exist

Throws:

APIException

getPersonAttributeTypeByUuid

@Authorized(value="Get Person Attribute Types")
PersonAttributeType getPersonAttributeTypeByUuid(String uuid)

Gets a person attribute type with the given uuid.

Parameters:

uuid - the universally unique identifier to lookup

Returns:

a person attribute type with the given uuid Should find object given valid uuid Should return null if no object found with given uuid

getPersonAttribute

@Authorized(value="Get Person Attribute Types")
PersonAttribute getPersonAttribute(Integer id)
                                                                            throws APIException

Get a PersonAttribute from the database with the given PersonAttributeid

Parameters:

id - the PersonAttribute.personAttributeId to match on

Returns:

the matching PersonAttribute or null if none was found

Throws:

APIException - Should return null when PersonAttribute with given id does not exist Should return person attribute when PersonAttribute with given id does exist

getPersonAttributeTypeByName

@Authorized(value="Get Person Attribute Types")
PersonAttributeType getPersonAttributeTypeByName(String typeName)
                                                                                          throws APIException

Get the PersonAttributeType given the type's name

Parameters:

typeName -

Returns:

the PersonAttributeType that has the given name or null if none found Should return person attribute type when name matches given typeName Should return null when no person attribute type match given typeName

Throws:

APIException

getRelationship

@Authorized(value="Get Relationships")
Relationship getRelationship(Integer relationshipId)
                                                             throws APIException

Get relationship by internal relationship identifier

Parameters:

relationshipId -

Returns:

Relationship the relationship to match on or null if none found

Throws:

APIException - Should return relationship with given id Should return null when relationship with given id does not exist

getRelationshipByUuid

@Authorized(value="Get Relationships")
Relationship getRelationshipByUuid(String uuid)
                                                                   throws APIException

Get Relationship by its UUID

Parameters:

uuid -

Returns:

relationship or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getAllRelationships

@Authorized(value="Get Relationships")
List<Relationship> getAllRelationships()
                                                                       throws APIException

Get list of relationships that are not voided

Returns:

non-voided Relationship list

Throws:

APIException

getAllRelationships

@Authorized(value="Get Relationships")
List<Relationship> getAllRelationships(boolean includeVoided)
                                                                       throws APIException

Get list of relationships optionally including the voided ones or not

Parameters:

includeVoided - true/false whether to include the voided relationships

Returns:

non-voided Relationship list

Throws:

APIException - Should return all relationship including voided when include voided equals true Should return all relationship excluding voided when include voided equals false

getRelationshipsByPerson

@Authorized(value="Get Relationships")
List<Relationship> getRelationshipsByPerson(Person p)
                                                                            throws APIException

Get list of relationships that include Person in person_id or relative_id Does not include voided relationships

Parameters:

p - person object listed on either side of the relationship

Returns:

Relationship list

Throws:

APIException - Should only get unvoided relationships Should fetch relationships associated with the given person Should fetch unvoided relationships only

getRelationshipsByPerson

@Authorized(value="Get Relationships")
List<Relationship> getRelationshipsByPerson(Person p,
                                                                                   Date effectiveDate)
                                                                            throws APIException

Get list of relationships that include Person in person_id or relative_id. Does not include voided relationships. Accepts an effectiveDate parameter which, if supplied, will limit the returned relationships to those that were active on the given date. Such active relationships include those that have a startDate that is null or less than or equal to the effectiveDate, and that have an endDate that is null or greater than or equal to the effectiveDate.

Parameters:

p - person object listed on either side of the relationship

effectiveDate - effective date of relationship

Returns:

Relationship list

Throws:

APIException - Should only get unvoided relationships Should only get unvoided relationships regardless of effective date Should fetch relationships associated with the given person Should fetch relationships that were active during effectiveDate

getRelationships

@Authorized(value="Get Relationships")
List<Relationship> getRelationships(Person fromPerson,
                                                                           Person toPerson,
                                                                           RelationshipType relType)
                                                                    throws APIException

Get relationships stored in the database that

Parameters:

fromPerson - (optional) Person to in the person_id column

toPerson - (optional) Person in the relative_id column

relType - (optional) The RelationshipType to match

Returns:

relationships matching the given parameters

Throws:

APIException - Should fetch relationships matching the given from person Should fetch relationships matching the given to person Should fetch relationships matching the given rel type Should return empty list when no relationship matching given parameters exist

getRelationships

@Authorized(value="Get Relationships")
List<Relationship> getRelationships(Person fromPerson,
                                                                           Person toPerson,
                                                                           RelationshipType relType,
                                                                           Date effectiveDate)
                                                                    throws APIException

Get relationships stored in the database that are active on the passed date

Parameters:

fromPerson - (optional) Person to in the person_id column

toPerson - (optional) Person in the relative_id column

relType - (optional) The RelationshipType to match

effectiveDate - (optional) The date during which the relationship was effective

Returns:

relationships matching the given parameters

Throws:

APIException - Should fetch relationships matching the given from person Should fetch relationships matching the given to person Should fetch relationships matching the given rel type Should return empty list when no relationship matching given parameters exist Should fetch relationships that were active during effectiveDate

getRelationships

@Authorized(value="Get Relationships")
List<Relationship> getRelationships(Person fromPerson,
                                                                           Person toPerson,
                                                                           RelationshipType relType,
                                                                           Date startEffectiveDate,
                                                                           Date endEffectiveDate)
                                                                    throws APIException

Get relationships stored in the database that were active during the specified date range

Parameters:

fromPerson - (optional) Person to in the person_id column

toPerson - (optional) Person in the relative_id column

relType - (optional) The RelationshipType to match

startEffectiveDate - (optional) The date during which the relationship was effective (lower bound)

endEffectiveDate - (optional) The date during which the relationship was effective (upper bound)

Returns:

relationships matching the given parameters

Throws:

APIException - Should fetch relationships matching the given from person Should fetch relationships matching the given to person Should fetch relationships matching the given rel type Should return empty list when no relationship matching given parameters exist Should fetch relationships that were active during the specified date range

getAllRelationshipTypes

@Authorized(value="Get Relationship Types")
List<RelationshipType> getAllRelationshipTypes()
                                                                                    throws APIException

Get all relationshipTypes Includes retired relationship types

Returns:

relationshipType list

Throws:

APIException - Should return all relationship types

getAllRelationshipTypes

@Authorized(value="Get Relationship Types")
List<RelationshipType> getAllRelationshipTypes(boolean includeRetired)
                                                                                    throws APIException

Get all relationshipTypes with the option of including the retired types

Parameters:

includeRetired - boolean - include retired relationshipTypes as well?

Returns:

relationshipType list

Throws:

APIException

getRelationshipType

@Authorized(value="Get Relationship Types")
RelationshipType getRelationshipType(Integer relationshipTypeId)
                                                                          throws APIException

Get relationshipType by internal identifier

Parameters:

relationshipTypeId -

Returns:

relationshipType with given internal identifier or null if none found

Throws:

APIException - Should return relationship type with the given relationship type id Should return null when no relationship type matches given relationship type id

getRelationshipTypeByUuid

@Authorized(value="Get Relationship Types")
RelationshipType getRelationshipTypeByUuid(String uuid)
                                                                                throws APIException

Gets the relationship type with the given uuid.

Parameters:

uuid -

Returns:

relationship type or null

Throws:

APIException - Should find object given valid uuid Should return null if no object found with given uuid

getRelationshipTypeByName

@Authorized(value="Get Relationship Types")
RelationshipType getRelationshipTypeByName(String relationshipTypeName)
                                                                                throws APIException

Find relationshipType by exact name match

Parameters:

relationshipTypeName - name to match on

Returns:

RelationshipType with given name or null if none found

Throws:

APIException - Should return null when no relationship type match the given name

getRelationshipTypes

@Authorized(value="Get Relationship Types")
List<RelationshipType> getRelationshipTypes(String relationshipTypeName,
                                                                                        Boolean preferred)
                                                                                 throws APIException

Find relationshipTypes by exact name match and/or preferred status

Parameters:

relationshipTypeName - name to match on

preferred - if true, returns on preferred types, if false returns only the nonpreferred types. if null returns both

Returns:

RelationshipTypes with given name and preferred status

Throws:

APIException - Should return list of preferred relationship type matching given name Should return empty list when no preferred relationship type match the given name

getRelationshipTypes

@Authorized(value="Get Relationship Types")
List<RelationshipType> getRelationshipTypes(String searchString)
                                                                                 throws APIException

Get relationshipTypes by searching through the names and loosely matching to the given searchString

Parameters:

searchString - string to match to a relationship type name

Returns:

list of relationship types or empty list if none found

Throws:

APIException - Should return empty list when no relationship type match the search string

saveRelationship

@Authorized(value={"Add Relationships","Edit Relationships"})
Relationship saveRelationship(Relationship relationship)
                                                                                     throws APIException

Create or update a relationship between people. Saves the given relationship to the database

Parameters:

relationship - relationship to be created or updated

Returns:

relationship that was created or updated

Throws:

APIException - Should create new object when relationship id is null Should update existing object when relationship id is not null

purgeRelationship

@Authorized(value="Purge Relationships")
void purgeRelationship(Relationship relationship)
                                                         throws APIException

Purges a relationship from the database (cannot be undone)

Parameters:

relationship - relationship to be purged from the database

Throws:

APIException - Should delete relationship from the database

voidRelationship

@Authorized(value="Delete Relationships")
Relationship voidRelationship(Relationship relationship,
                                                                        String voidReason)
                                                                 throws APIException

Voids the given Relationship, effectively removing it from openmrs.

Parameters:

relationship - Relationship to void

voidReason - String reason the relationship is being voided.

Returns:

the newly saved relationship

Throws:

APIException - Should void relationship with the given reason

unvoidRelationship

@Authorized(value="Edit Relationships")
Relationship unvoidRelationship(Relationship relationship)
                                                                 throws APIException

Unvoid Relationship in the database, effectively marking this as a valid relationship again

Parameters:

relationship - Relationship to unvoid

Returns:

the newly unvoided relationship

Throws:

APIException - Should unvoid voided relationship

savePerson

@Authorized(value={"Add People","Edit People"})
Person savePerson(Person person)
                                                           throws APIException

Creates or updates a Person in the database

Parameters:

person - person to be created or updated

Returns:

person who was created or updated

Throws:

APIException - Should create new object when person id is null Should update existing object when person id is not null Should set the preferred name and address if none is specified Should not set the preferred name and address if they already exist Should not set a voided name or address as preferred

purgePerson

@Authorized(value="Purge People")
void purgePerson(Person person)
                                            throws APIException

Purges a person from the database (cannot be undone)

Parameters:

person - person to be purged from the database

Throws:

APIException - Should delete person from the database

getPersonByUuid

@Authorized(value="Get People")
Person getPersonByUuid(String uuid)
                                                throws APIException

Get Person by its UUID

Parameters:

uuid -

Returns:

person or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getPersonAddressByUuid

@Authorized(value="Get People")
PersonAddress getPersonAddressByUuid(String uuid)
                                                              throws APIException

Get PersonAddress by its UUID

Parameters:

uuid -

Returns:

person address or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getPersonAttributeByUuid

@Authorized(value="Get People")
PersonAttribute getPersonAttributeByUuid(String uuid)
                                                                  throws APIException

Get PersonAttribute by its UUID

Parameters:

uuid -

Returns:

person attribute or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getPersonName

@Authorized(value="Get People")
PersonName getPersonName(Integer personNameId)

Get PersonName by its personNameId

Parameters:

personNameId -

Returns:

person name or null Should find PersonName given valid personNameId Should return null if no object found with given personNameId

getPersonNameByUuid

@Authorized(value="Get People")
PersonName getPersonNameByUuid(String uuid)
                                                        throws APIException

Get PersonName by its UUID

Parameters:

uuid -

Returns:

person name or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getPerson

@Authorized(value="Get People")
Person getPerson(Integer personId)
                                          throws APIException

Gets a person by internal id

Parameters:

personId - internal identifier of person to get

Returns:

Person person with given internal identifier

Throws:

APIException - Should return null when no person has the given id

saveRelationshipType

@Authorized(value="Manage Relationship Types")
RelationshipType saveRelationshipType(RelationshipType relationshipType)
                                                                              throws APIException

Inserts or updates the given relationship type object in the database

Parameters:

relationshipType - type to be created or updated

Returns:

relationship type that was created or updated

Throws:

APIException - Should create new object when relationship type id is null Should update existing object when relationship type id is not null Should fail if the description is not specified

purgeRelationshipType

@Authorized(value="Purge Relationship Types")
void purgeRelationshipType(RelationshipType relationshipType)
                                                                  throws APIException

Purge relationship type from the database (cannot be undone)

Parameters:

relationshipType - relationship type to be purged

Throws:

APIException - Should delete relationship type from the database

getPersonAttributeTypes

List<PersonAttributeType> getPersonAttributeTypes(OpenmrsConstants.PERSON_TYPE personType,
                                                  PersonService.ATTR_VIEW_TYPE viewType)
                                           throws APIException

Gets the types defined for the given person type (person, user, patient) and the given type of view (one person vs many person objects)

Parameters:

personType - PERSON, USER, PATIENT, or null. Both PERSON and null mean to return attr types for both patients and users

viewType - whether this is a listing or viewing or null for both listing and viewing

Returns:

list of PersonAttributeTypes that should be displayed

Throws:

APIException

voidPersonName

@Authorized(value="Edit People")
PersonName voidPersonName(PersonName personName,
                                                           String voidReason)

Voids the given PersonName, effectively deleting the name, from the end-user's point of view.

Parameters:

personName - PersonName to void

voidReason - String reason the personName is being voided.

Returns:

the newly saved personName

Throws:

APIException - Should void personName with the given reason

unvoidPersonName

@Authorized(value="Edit People")
PersonName unvoidPersonName(PersonName personName)
                                                      throws APIException

Unvoid PersonName in the database, effectively marking this as a valid personName again

Parameters:

personName - PersonName to unvoid

Returns:

the newly unvoided personName

Throws:

APIException - Should unvoid voided personName

savePersonName

@Authorized(value="Edit People")
PersonName savePersonName(PersonName personName)

Inserts or updates the given personName object in the database

Parameters:

personName - to be created or updated

Returns:

personName that was created or updated

Throws:

APIException - Should fail if you try to void the last non voided name

parsePersonName

PersonName parsePersonName(String name)
                    throws APIException

Parses a name into a PersonName (separate Given, Middle, and Family names)

Parameters:

name - person name to be parsed

Returns:

parsed person name Should parse two person name with comma Should parse two person name without comma Should not fail when ending with whitespace Should not fail when ending with a comma Should parse four person name

Throws:

APIException

getRelationshipMap

@Authorized(value="Get Relationships")
Map<Person,List<Person>> getRelationshipMap(RelationshipType relationshipType)
                                                                            throws APIException

Get all relationships for a given type of relationship mapped from the personA to all of the personB's

Parameters:

relationshipType - type of relationship for which to retrieve all relationships

Returns:

all relationships for the given type of relationship

Throws:

APIException - Should return empty map when no relationship has the matching relationship type

savePersonMergeLog

PersonMergeLog savePersonMergeLog(PersonMergeLog personMergeLog)
                           throws SerializationException,
                                  APIException

Builds the serialized data from PersonMergeLog.getPersonMergeLogData(), sets the mergedData String, and the creator and date if null. It then saves the PersonMergeLog object to the model.

Parameters:

personMergeLog - the PersonMergeLog object to save.

Returns:

the persisted PersonMergeLog object

Throws:

SerializationException

APIException

See Also:

PersonMergeLog, Should require PersonMergeLogData Should require winner Should require loser Should set date created if null Should set creator if null Should serialize PersonMergeLogData Should save PersonMergeLog

getPersonMergeLogByUuid

PersonMergeLog getPersonMergeLogByUuid(String uuid,
                                       boolean deserialize)
                                throws SerializationException,
                                       APIException

Gets a PersonMergeLog object from the model using the UUID identifier. Deserializes the

Parameters:

uuid -

deserialize -

Returns:

person merge log object

Throws:

SerializationException

APIException - Should require uuid Should retrieve personMergeLog without deserializing data Should retrieve personMergeLog and deserialize data

getAllPersonMergeLogs

List<PersonMergeLog> getAllPersonMergeLogs(boolean deserialize)
                                    throws SerializationException

Gets all the PersonMergeLog objects from the model

Returns:

list of PersonMergeLog objects

Throws:

SerializationException - Should retrieve all PersonMergeLogs from the model Should retrieve all PersonMergeLogs and deserialize them

getWinningPersonMergeLogs

List<PersonMergeLog> getWinningPersonMergeLogs(Person person,
                                               boolean deserialize)
                                        throws SerializationException

Gets PersonMergeLog objects by winning person p. Useful for to getting all persons merged into p.

Parameters:

person - the winning person

Returns:

List of PersonMergeLog objects

Throws:

SerializationException - Should retrieve PersonMergeLogs by winner

getLosingPersonMergeLog

PersonMergeLog getLosingPersonMergeLog(Person person,
                                       boolean deserialize)
                                throws SerializationException

Gets the PersonMergeLog where person p is the loser. Useful for getting the person that p was merged into.

Parameters:

person - the losing person

Returns:

The PersonMergeLog object

Throws:

SerializationException - Should find PersonMergeLog by loser

voidPersonAddress

@Authorized(value="Edit People")
PersonAddress voidPersonAddress(PersonAddress personAddress,
                                                                 String voidReason)

Voids the given PersonAddress, effectively deleting the personAddress, from the end-user's point of view.

Parameters:

personAddress - PersonAddress to void

voidReason - String reason the personAddress is being voided.

Returns:

the newly saved personAddress

Throws:

APIException - Should void personAddress with the given reason

unvoidPersonAddress

@Authorized(value="Edit People")
PersonAddress unvoidPersonAddress(PersonAddress personAddress)
                                                            throws APIException

Unvoid PersonAddress in the database, effectively marking this as a valid PersonAddress again

Parameters:

personAddress - PersonAddress to unvoid

Returns:

the newly unvoided personAddress

Throws:

APIException - Should unvoid voided personAddress

savePersonAddress

@Authorized(value="Edit People")
PersonAddress savePersonAddress(PersonAddress personAddress)

Inserts or updates the given personAddress object in the database

Parameters:

personAddress - PersonAddress to be created or updated

Returns:

personAddress that was created or updated

Since:

1.9

checkIfPersonAttributeTypesAreLocked

void checkIfPersonAttributeTypesAreLocked()
                                   throws PersonAttributeTypeLockedException

Check if the person attribute types are locked, and if they are throws an exception during manipulation of a person attribute type

Throws:

PersonAttributeTypeLockedException