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)
List<PersonAttributeType>	getAllPersonAttributeTypes(boolean includeRetired)
List<PersonMergeLog>	getAllPersonMergeLogs() Gets all the PersonMergeLog objects in the model
List<Relationship>	getAllRelationships(boolean includeVoided)
List<RelationshipType>	getAllRelationshipTypes(boolean includeRetired)
PersonMergeLog	getLosingPersonMergeLogs(Person person) Finds the PersonMergeLog by loser
List<Person>	getPeople(String searchPhrase, Boolean dead)
List<Person>	getPeople(String searchPhrase, Boolean dead, Boolean voided)
Person	getPerson(Integer personId)
PersonAddress	getPersonAddressByUuid(String uuid)
PersonAttribute	getPersonAttribute(Integer id)
PersonAttribute	getPersonAttributeByUuid(String uuid)
PersonAttributeType	getPersonAttributeType(Integer typeId)
PersonAttributeType	getPersonAttributeTypeByUuid(String uuid)
List<PersonAttributeType>	getPersonAttributeTypes(String exactName, String format, Integer foreignKey, Boolean searchable)
Person	getPersonByUuid(String uuid)
PersonMergeLog	getPersonMergeLog(Integer id) Gets a PersonMergeLog object from the model by id
PersonMergeLog	getPersonMergeLogByUuid(String uuid) Gets a PersonMergeLog object from the model using UUID
PersonName	getPersonName(Integer personNameId)
PersonName	getPersonNameByUuid(String uuid)
Relationship	getRelationship(Integer relationshipId)
Relationship	getRelationshipByUuid(String uuid)
List<Relationship>	getRelationships(Person fromPerson, Person toPerson, RelationshipType relType)
List<Relationship>	getRelationships(Person fromPerson, Person toPerson, RelationshipType relType, Date startEffectiveDate, Date endEffectiveDate)
RelationshipType	getRelationshipType(Integer relationshipTypeId)
RelationshipType	getRelationshipTypeByUuid(String uuid)
List<RelationshipType>	getRelationshipTypes(String relationshipTypeName, Boolean preferred)
String	getSavedPersonAttributeTypeName(PersonAttributeType personAttributeType) Gets the value of name currently saved in the database for the given personAttributeType, bypassing any caches.
Boolean	getSavedPersonAttributeTypeSearchable(PersonAttributeType personAttributeType) Gets the value of the searchable property currently saved in the database for the given personAttributeType, bypassing any caches.
Set<Person>	getSimilarPeople(String name, Integer birthyear, String gender)
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

Set<Person> getSimilarPeople(String name,
                             Integer birthyear,
                             String gender)
                      throws DAOException

Throws:

DAOException

See Also:

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

getPeople

List<Person> getPeople(String searchPhrase,
                       Boolean dead)
                throws DAOException

Throws:

DAOException

See Also:

PersonService.getPeople(String, Boolean)

getPeople

List<Person> getPeople(String searchPhrase,
                       Boolean dead,
                       Boolean voided)
                throws DAOException

Throws:

DAOException

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

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

Throws:

DAOException

See Also:

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

getAllPersonAttributeTypes

List<PersonAttributeType> getAllPersonAttributeTypes(boolean includeRetired)
                                              throws DAOException

Throws:

DAOException

See Also:

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

getPersonAttributeType

PersonAttributeType getPersonAttributeType(Integer typeId)
                                    throws DAOException

Throws:

DAOException

See Also:

PersonService.getPersonAttributeType(java.lang.Integer)

getPersonAttribute

PersonAttribute getPersonAttribute(Integer id)
                            throws DAOException

Throws:

DAOException

See Also:

PersonService.getPersonAttribute(java.lang.Integer)

getRelationship

Relationship getRelationship(Integer relationshipId)
                      throws DAOException

Throws:

DAOException

See Also:

PersonService.getRelationship(java.lang.Integer)

getAllRelationships

List<Relationship> getAllRelationships(boolean includeVoided)
                                throws DAOException

Throws:

DAOException

See Also:

PersonService.getAllRelationships(boolean)

getRelationshipType

RelationshipType getRelationshipType(Integer relationshipTypeId)
                              throws DAOException

Throws:

DAOException

See Also:

PersonService.getRelationshipType(java.lang.Integer)

getRelationshipTypes

List<RelationshipType> getRelationshipTypes(String relationshipTypeName,
                                            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:

org.openmrs.api.PersonService#deletePerson(org.openmrs.Person)

getPerson

Person getPerson(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

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

List<Relationship> getRelationships(Person fromPerson,
                                    Person toPerson,
                                    RelationshipType relType,
                                    Date startEffectiveDate,
                                    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:

org.openmrs.api.PersonService#deleteRelationshipType(org.openmrs.RelationshipType)

getPersonByUuid

Person getPersonByUuid(String uuid)

Parameters:

uuid -

Returns:

person or null

getPersonAddressByUuid

PersonAddress getPersonAddressByUuid(String uuid)

getPersonAttributeByUuid

PersonAttribute getPersonAttributeByUuid(String uuid)

getPersonName

PersonName getPersonName(Integer personNameId)

getPersonNameByUuid

PersonName getPersonNameByUuid(String uuid)

getRelationshipByUuid

Relationship getRelationshipByUuid(String uuid)

Parameters:

uuid -

Returns:

relationship or null

getRelationshipTypeByUuid

RelationshipType getRelationshipTypeByUuid(String uuid)

Parameters:

uuid -

Returns:

relationship type or null

getPersonAttributeTypeByUuid

PersonAttributeType getPersonAttributeTypeByUuid(String uuid)

Parameters:

uuid -

Returns:

person attribute type or null

getSavedPersonAttributeTypeName

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 Should get saved personAttributeType name from database

getSavedPersonAttributeTypeSearchable

Boolean getSavedPersonAttributeTypeSearchable(PersonAttributeType personAttributeType)

Gets the value of the searchable property currently saved in the database for the given personAttributeType, bypassing any caches. This is used when saving an personAttributeType, so that we can determine if the searchable property has changed, which we use to determine whether we need to update the Lucene index

Parameters:

personAttributeType -

Returns:

the searchable property currently in the database for this personAttributeType

getAllRelationshipTypes

List<RelationshipType> getAllRelationshipTypes(boolean includeRetired)

See Also:

PersonService.getAllRelationshipTypes(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(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(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

List<PersonMergeLog> getAllPersonMergeLogs()
                                    throws DAOException

Gets all the PersonMergeLog objects in the model

Returns:

list of PersonMergeLog objects

Throws:

DAOException

getWinningPersonMergeLogs

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)