org.openmrs.api.db

Interface CohortDAO

All Known Implementing Classes:

HibernateCohortDAO

public interface CohortDAO

Database methods for cohort objects.

See Also:

Cohort, CohortService, Context

Method Summary

Modifier and Type	Method and Description
Cohort	deleteCohort(Cohort cohort) Removes a cohort from the database
List<Cohort>	getAllCohorts(boolean includeVoided) Gets all cohorts in the database
Cohort	getCohort(Integer id) Finds the cohort with the given primary key
Cohort	getCohort(String name) Finds a cohort by name
Cohort	getCohortByUuid(String uuid)
CohortMembership	getCohortMembershipByUuid(String uuid)
List<CohortMembership>	getCohortMemberships(Integer patientId, Date activeOnDate, boolean includeVoided)
List<Cohort>	getCohorts(String nameFragment) Finds all Cohorts with matching names
List<Cohort>	getCohortsContainingPatientId(Integer patientId, boolean includeVoided, Date asOfDate) Finds all cohorts that contain the given patientId
Cohort	saveCohort(Cohort cohort) Saves a Cohort to the database
CohortMembership	saveCohortMembership(CohortMembership cohortMembership)

Method Detail

getCohort

Cohort getCohort(Integer id)
          throws DAOException

Finds the cohort with the given primary key

Parameters:

id -

Returns:

The cohort with the given cohortId, or null if none exists

Throws:

DAOException

getCohort

Cohort getCohort(String name)

Finds a cohort by name

Parameters:

name -

Returns:

The Cohort with the given name, or null if none exists

getAllCohorts

List<Cohort> getAllCohorts(boolean includeVoided)
                    throws DAOException

Gets all cohorts in the database

Parameters:

includeVoided - whether to include voided cohorts

Returns:

All cohorts in the database, possibly including voided ones

Throws:

DAOException

getCohortsContainingPatientId

List<Cohort> getCohortsContainingPatientId(Integer patientId,
                                           boolean includeVoided,
                                           Date asOfDate)

Finds all cohorts that contain the given patientId

Parameters:

patientId - patient id to get the cohorts containing the patient

includeVoided - voided true/false whether or not to include voided cohorts

asOfDate -

Returns:

matching cohorts

Throws:

DAOException

saveCohort

Cohort saveCohort(Cohort cohort)
           throws DAOException

Saves a Cohort to the database

Parameters:

cohort - Cohort to save

Returns:

the saved Cohort

Throws:

DAOException

getCohorts

List<Cohort> getCohorts(String nameFragment)
                 throws DAOException

Finds all Cohorts with matching names

Parameters:

nameFragment -

Returns:

List<Cohort> object of matching Cohorts

Throws:

DAOException

deleteCohort

Cohort deleteCohort(Cohort cohort)
             throws DAOException

Removes a cohort from the database

Parameters:

cohort -

Returns:

the deleted Cohort

Throws:

DAOException

getCohortByUuid

Cohort getCohortByUuid(String uuid)

Parameters:

uuid -

Returns:

cohort or null

getCohortMembershipByUuid

CohortMembership getCohortMembershipByUuid(String uuid)

Parameters:

uuid -

Returns:

cohort membership or null

Since:

2.1.0

getCohortMemberships

List<CohortMembership> getCohortMemberships(Integer patientId,
                                            Date activeOnDate,
                                            boolean includeVoided)

Parameters:

patientId -

activeOnDate - optional

includeVoided -

Returns:

cohort memberships for the given patient (optionally active on a given date)

Since:

2.1.0

saveCohortMembership

CohortMembership saveCohortMembership(CohortMembership cohortMembership)

Parameters:

cohortMembership -

Returns:

the cohortMembership (now persisted or updated)

Since:

2.1.0