org.openmrs.api.db

Interface PersonDAO

All Known Implementing Classes:

HibernatePersonDAO

public interface PersonDAO

Person-related database functions

This is used by the PersonService. This should not be used directly, but rather used through the methods on the PersonService.

Use case: PersonService ps = Context.getPersonService(); ps....

See Also:

PersonService, Context

Method Summary

Modifier and Type	Method and Description
void	deletePerson(Person person)
void	deletePersonAttributeType(PersonAttributeType type)
void	deleteRelationship(Relationship relationship)
void	deleteRelationshipType(RelationshipType relationshipType)
java.util.List<PersonAttributeType>	getAllPersonAttributeTypes(boolean includeRetired)
java.util.List<PersonMergeLog>	getAllPersonMergeLogs() Gets all the PersonMergeLog objects in the model
java.util.List<Relationship>	getAllRelationships(boolean includeVoided)
java.util.List<RelationshipType>	getAllRelationshipTypes(boolean includeRetired)
PersonMergeLog	getLosingPersonMergeLogs(Person person) Finds the PersonMergeLog by loser
java.util.List<Person>	getPeople(java.lang.String searchPhrase, java.lang.Boolean dead)
Person	getPerson(java.lang.Integer personId)
PersonAddress	getPersonAddressByUuid(java.lang.String uuid)
PersonAttribute	getPersonAttribute(java.lang.Integer id)
PersonAttribute	getPersonAttributeByUuid(java.lang.String uuid)
PersonAttributeType	getPersonAttributeType(java.lang.Integer typeId)
PersonAttributeType	getPersonAttributeTypeByUuid(java.lang.String uuid) Auto generated method comment
java.util.List<PersonAttributeType>	getPersonAttributeTypes(java.lang.String exactName, java.lang.String format, java.lang.Integer foreignKey, java.lang.Boolean searchable)
Person	getPersonByUuid(java.lang.String uuid) Auto generated method comment
PersonMergeLog	getPersonMergeLog(java.lang.Integer id) Gets a PersonMergeLog object from the model by id
PersonMergeLog	getPersonMergeLogByUuid(java.lang.String uuid) Gets a PersonMergeLog object from the model using UUID
PersonName	getPersonName(java.lang.Integer personNameId)
PersonName	getPersonNameByUuid(java.lang.String uuid)
Relationship	getRelationship(java.lang.Integer relationshipId)
Relationship	getRelationshipByUuid(java.lang.String uuid) Auto generated method comment
java.util.List<Relationship>	getRelationships(Person fromPerson, Person toPerson, RelationshipType relType)
java.util.List<Relationship>	getRelationships(Person fromPerson, Person toPerson, RelationshipType relType, java.util.Date startEffectiveDate, java.util.Date endEffectiveDate)
RelationshipType	getRelationshipType(java.lang.Integer relationshipTypeId)
RelationshipType	getRelationshipTypeByUuid(java.lang.String uuid) Auto generated method comment
java.util.List<RelationshipType>	getRelationshipTypes(java.lang.String relationshipTypeName, java.lang.Boolean preferred)
java.lang.String	getSavedPersonAttributeTypeName(PersonAttributeType personAttributeType) Gets the value of name currently saved in the database for the given personAttributeType, bypassing any caches.
java.util.Set<Person>	getSimilarPeople(java.lang.String name, java.lang.Integer birthyear, java.lang.String gender)
java.util.List<PersonMergeLog>	getWinningPersonMergeLogs(Person person) Gets the PersonMergeLog objects by winner
Person	savePerson(Person person)
PersonAddress	savePersonAddress(PersonAddress personAddress)
PersonAttributeType	savePersonAttributeType(PersonAttributeType type)
PersonMergeLog	savePersonMergeLog(PersonMergeLog personMergeLog) Saves a PersonMergeLog object to the database
PersonName	savePersonName(PersonName personName)
Relationship	saveRelationship(Relationship relationship)
RelationshipType	saveRelationshipType(RelationshipType relationshipType)

Method Detail

getSimilarPeople

java.util.Set<Person> getSimilarPeople(java.lang.String name,
                                       java.lang.Integer birthyear,
                                       java.lang.String gender)
                                throws DAOException

Throws:

DAOException

See Also:

PersonService.getSimilarPeople(java.lang.String, java.lang.Integer, java.lang.String)

getPeople

java.util.List<Person> getPeople(java.lang.String searchPhrase,
                                 java.lang.Boolean dead)
                          throws DAOException

Throws:

DAOException

See Also:

PersonService.getPeople(String, Boolean)

savePersonAttributeType

PersonAttributeType savePersonAttributeType(PersonAttributeType type)
                                     throws DAOException

Throws:

DAOException

See Also:

PersonService.savePersonAttributeType(org.openmrs.PersonAttributeType)

deletePersonAttributeType

void deletePersonAttributeType(PersonAttributeType type)
                        throws DAOException

Throws:

DAOException

See Also:

PersonService.purgePersonAttributeType(org.openmrs.PersonAttributeType)

getPersonAttributeTypes

java.util.List<PersonAttributeType> getPersonAttributeTypes(java.lang.String exactName,
                                                            java.lang.String format,
                                                            java.lang.Integer foreignKey,
                                                            java.lang.Boolean searchable)
                                                     throws DAOException

Throws:

DAOException

See Also:

PersonService.getPersonAttributeTypes(java.lang.String, java.lang.String, java.lang.Integer, java.lang.Boolean)

getAllPersonAttributeTypes

java.util.List<PersonAttributeType> getAllPersonAttributeTypes(boolean includeRetired)
                                                        throws DAOException

Throws:

DAOException

See Also:

PersonService.getAllPersonAttributeTypes(), PersonService.getAllPersonAttributeTypes(boolean)

getPersonAttributeType

PersonAttributeType getPersonAttributeType(java.lang.Integer typeId)
                                    throws DAOException

Throws:

DAOException

See Also:

PersonService.getPersonAttributeType(java.lang.Integer)

getPersonAttribute

PersonAttribute getPersonAttribute(java.lang.Integer id)
                            throws DAOException

Throws:

DAOException

See Also:

PersonService.getPersonAttribute(java.lang.Integer)

getRelationship

Relationship getRelationship(java.lang.Integer relationshipId)
                      throws DAOException

Throws:

DAOException

See Also:

PersonService.getRelationship(java.lang.Integer)

getAllRelationships

java.util.List<Relationship> getAllRelationships(boolean includeVoided)
                                          throws DAOException

Throws:

DAOException

See Also:

PersonService.getAllRelationships(boolean)

getRelationshipType

RelationshipType getRelationshipType(java.lang.Integer relationshipTypeId)
                              throws DAOException

Throws:

DAOException

See Also:

PersonService.getRelationshipType(java.lang.Integer)

getRelationshipTypes

java.util.List<RelationshipType> getRelationshipTypes(java.lang.String relationshipTypeName,
                                                      java.lang.Boolean preferred)
                                               throws DAOException

Throws:

DAOException

See Also:

PersonService.getRelationshipTypes(java.lang.String, java.lang.Boolean)

savePerson

Person savePerson(Person person)
           throws DAOException

Throws:

DAOException

See Also:

PersonService.savePerson(org.openmrs.Person)

deletePerson

void deletePerson(Person person)
           throws DAOException

Throws:

DAOException

See Also:

PersonService.deletePerson(org.openmrs.Person)

getPerson

Person getPerson(java.lang.Integer personId)
          throws DAOException

Throws:

DAOException

See Also:

PersonService.getPerson(java.lang.Integer)

saveRelationship

Relationship saveRelationship(Relationship relationship)
                       throws DAOException

Throws:

DAOException

See Also:

PersonService.saveRelationship(org.openmrs.Relationship)

deleteRelationship

void deleteRelationship(Relationship relationship)
                 throws DAOException

Throws:

DAOException

See Also:

PersonService.purgeRelationship(org.openmrs.Relationship)

getRelationships

java.util.List<Relationship> getRelationships(Person fromPerson,
                                              Person toPerson,
                                              RelationshipType relType)
                                       throws DAOException

Throws:

DAOException

See Also:

PersonService.getRelationships(org.openmrs.Person, org.openmrs.Person, org.openmrs.RelationshipType)

getRelationships

java.util.List<Relationship> getRelationships(Person fromPerson,
                                              Person toPerson,
                                              RelationshipType relType,
                                              java.util.Date startEffectiveDate,
                                              java.util.Date endEffectiveDate)
                                       throws DAOException

Throws:

DAOException

See Also:

PersonService.getRelationships(org.openmrs.Person, org.openmrs.Person, org.openmrs.RelationshipType, java.util.Date, java.util.Date)

saveRelationshipType

RelationshipType saveRelationshipType(RelationshipType relationshipType)
                               throws DAOException

Throws:

DAOException

See Also:

PersonService.saveRelationshipType(org.openmrs.RelationshipType)

deleteRelationshipType

void deleteRelationshipType(RelationshipType relationshipType)
                     throws DAOException

Throws:

DAOException

See Also:

PersonService.deleteRelationshipType(org.openmrs.RelationshipType)

getPersonByUuid

Person getPersonByUuid(java.lang.String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getPersonAddressByUuid

PersonAddress getPersonAddressByUuid(java.lang.String uuid)

getPersonAttributeByUuid

PersonAttribute getPersonAttributeByUuid(java.lang.String uuid)

getPersonName

PersonName getPersonName(java.lang.Integer personNameId)

getPersonNameByUuid

PersonName getPersonNameByUuid(java.lang.String uuid)

getRelationshipByUuid

Relationship getRelationshipByUuid(java.lang.String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getRelationshipTypeByUuid

RelationshipType getRelationshipTypeByUuid(java.lang.String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getPersonAttributeTypeByUuid

PersonAttributeType getPersonAttributeTypeByUuid(java.lang.String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getSavedPersonAttributeTypeName

java.lang.String getSavedPersonAttributeTypeName(PersonAttributeType personAttributeType)

Gets the value of name currently saved in the database for the given personAttributeType, bypassing any caches. This is used prior to saving an personAttributeType, so that we can change the vlaue of any global property which is in OpenmrsConstants.GLOBAL_PROPERTIES_OF_PERSON_ATTRIBUTES and reference the given personAttributeType.

Parameters:

personAttributeType - the personAttributeType get the the name of

Returns:

the name currently in the database for this personAttributeType

getAllRelationshipTypes

java.util.List<RelationshipType> getAllRelationshipTypes(boolean includeRetired)

See Also:

org.openmrs.api.PersonService#getAllRelationshipTypes(java.lang.Boolean)

savePersonMergeLog

PersonMergeLog savePersonMergeLog(PersonMergeLog personMergeLog)
                           throws DAOException

Saves a PersonMergeLog object to the database

Parameters:

personMergeLog - the PersonMergeLog object to save

Returns:

the persisted PersonMergeLog object

Throws:

DAOException

getPersonMergeLog

PersonMergeLog getPersonMergeLog(java.lang.Integer id)
                          throws DAOException

Gets a PersonMergeLog object from the model by id

Parameters:

id - the id of the PersonMergeLog object to retrieve

Returns:

the PersonMergeLog object

Throws:

DAOException

getPersonMergeLogByUuid

PersonMergeLog getPersonMergeLogByUuid(java.lang.String uuid)
                                throws DAOException

Gets a PersonMergeLog object from the model using UUID

Parameters:

uuid - the UUID of the PersonMergeLog object to retrieve

Returns:

the PersonMergeLog object

Throws:

DAOException

getAllPersonMergeLogs

java.util.List<PersonMergeLog> getAllPersonMergeLogs()
                                              throws DAOException

Gets all the PersonMergeLog objects in the model

Returns:

list of PersonMergeLog objects

Throws:

DAOException

getWinningPersonMergeLogs

java.util.List<PersonMergeLog> getWinningPersonMergeLogs(Person person)
                                                  throws DAOException

Gets the PersonMergeLog objects by winner

Parameters:

person - the winning person

Returns:

List of PersonMergeLog objects

Throws:

DAOException

getLosingPersonMergeLogs

PersonMergeLog getLosingPersonMergeLogs(Person person)
                                 throws DAOException

Finds the PersonMergeLog by loser

Parameters:

person -

Returns:

PersonMergeLog object

Throws:

DAOException

savePersonName

PersonName savePersonName(PersonName personName)

See Also:

PersonService.savePersonName(org.openmrs.PersonName)

savePersonAddress

PersonAddress savePersonAddress(PersonAddress personAddress)

See Also:

PersonService.savePersonAddress(org.openmrs.PersonAddress)