org.openmrs.api.impl

Class CohortServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.CohortServiceImpl

All Implemented Interfaces:

CohortService, OpenmrsService

@Transactional
public class CohortServiceImpl
extends BaseOpenmrsService
implements CohortService

API functions related to Cohorts

Constructor Summary

Constructors

Constructor and Description
CohortServiceImpl()

Method Summary

Modifier and Type	Method and Description
Cohort	addPatientToCohort(Cohort cohort, Patient patient) Adds a new patient to a Cohort.
CohortMembership	endCohortMembership(CohortMembership cohortMembership, Date onDate) Ends the specified CohortMembership i.e. sets its end date to the current date
List<Cohort>	getAllCohorts() Gets all Cohorts (not including voided ones)
List<Cohort>	getAllCohorts(boolean includeVoided) Gets all Cohorts, possibly including the voided ones
Cohort	getCohort(Integer id) Gets a Cohort by its database primary key
Cohort	getCohort(String name)
Cohort	getCohortByName(String name) Gets a non voided Cohort by its name
Cohort	getCohortByUuid(String uuid) Get Cohort by its UUID
CohortMembership	getCohortMembershipByUuid(String uuid) Get CohortMembership by its UUID
List<CohortMembership>	getCohortMemberships(Integer patientId, Date activeOnDate, boolean includeVoided) Gets memberships for the given patient, optionally active on a specific date
List<Cohort>	getCohorts(String nameFragment) Returns Cohorts whose names match the given string.
List<Cohort>	getCohortsContainingPatient(Patient patient)
List<Cohort>	getCohortsContainingPatientId(Integer patientId) Find all Cohorts that contain the given patientId right now.
void	notifyPatientUnvoided(Patient patient, User originallyVoidedBy, Date originalDateVoided) NOTE: CLIENT CODE SHOULD NEVER CALL THIS METHOD.
void	notifyPatientVoided(Patient patient) NOTE: CLIENT CODE SHOULD NEVER CALL THIS METHOD.
Cohort	purgeCohort(Cohort cohort) Completely removes a Cohort from the database (not reversible)
void	purgeCohortMembership(CohortMembership cohortMembership) Removes a CohortMembership from its parent Cohort
Cohort	removePatientFromCohort(Cohort cohort, Patient patient) Removes a patient from a Cohort, by voiding their membership.
Cohort	saveCohort(Cohort cohort) Save a cohort to the database (create if new, or update if changed) This method will throw an exception if any patientIds in the Cohort don't exist.
void	setCohortDAO(CohortDAO dao) Sets the CohortDAO for this service to use
Cohort	voidCohort(Cohort cohort, String reason) Voids the given cohort, deleting it from the perspective of the typical end user.
CohortMembership	voidCohortMembership(CohortMembership cohortMembership, String reason) Marks the specified CohortMembership as voided

Methods inherited from class org.openmrs.api.impl.BaseOpenmrsService

onShutdown, onStartup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Constructor Detail

CohortServiceImpl

public CohortServiceImpl()

Method Detail

setCohortDAO

public void setCohortDAO(CohortDAO dao)

Description copied from interface: CohortService

Sets the CohortDAO for this service to use

Specified by:

setCohortDAO in interface CohortService

See Also:

CohortService.setCohortDAO(org.openmrs.api.db.CohortDAO)

saveCohort

public Cohort saveCohort(Cohort cohort)
                  throws APIException

Description copied from interface: CohortService

Save a cohort to the database (create if new, or update if changed) This method will throw an exception if any patientIds in the Cohort don't exist.

Specified by:

saveCohort in interface CohortService

Parameters:

cohort - the cohort to be saved to the database

Returns:

The cohort that was passed in

Throws:

APIException - Should create new cohorts Should update an existing cohort

See Also:

CohortService.saveCohort(org.openmrs.Cohort)

getCohort

@Transactional(readOnly=true)
public Cohort getCohort(Integer id)

Description copied from interface: CohortService

Gets a Cohort by its database primary key

Specified by:

getCohort in interface CohortService

Returns:

the Cohort with the given primary key, or null if none exists

See Also:

CohortService.getCohort(java.lang.Integer)

voidCohort

public Cohort voidCohort(Cohort cohort,
                         String reason)

Description copied from interface: CohortService

Voids the given cohort, deleting it from the perspective of the typical end user.

Specified by:

voidCohort in interface CohortService

Parameters:

cohort - the cohort to delete

reason - the reason this cohort is being retired

Returns:

The cohort that was passed in

See Also:

CohortService.voidCohort(org.openmrs.Cohort, java.lang.String)

getCohortByUuid

@Transactional(readOnly=true)
public Cohort getCohortByUuid(String uuid)

Description copied from interface: CohortService

Get Cohort by its UUID

Specified by:

getCohortByUuid in interface CohortService

Returns:

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

See Also:

CohortService.getCohortByUuid(java.lang.String)

getCohortMembershipByUuid

@Transactional(readOnly=true)
public CohortMembership getCohortMembershipByUuid(String uuid)

Description copied from interface: CohortService

Get CohortMembership by its UUID

Specified by:

getCohortMembershipByUuid in interface CohortService

Returns:

cohort membership or null

See Also:

CohortService.getCohortMembershipByUuid(java.lang.String)

addPatientToCohort

public Cohort addPatientToCohort(Cohort cohort,
                                 Patient patient)

Description copied from interface: CohortService

Adds a new patient to a Cohort. If the patient is not already in the Cohort, then they are added, and the Cohort is saved, marking it as changed.

Specified by:

addPatientToCohort in interface CohortService

Parameters:

cohort - the cohort to receive the given patient

patient - the patient to insert into the cohort

Returns:

The cohort that was passed in with the new patient in it

See Also:

CohortService.addPatientToCohort(org.openmrs.Cohort, org.openmrs.Patient)

removePatientFromCohort

public Cohort removePatientFromCohort(Cohort cohort,
                                      Patient patient)

Description copied from interface: CohortService

Removes a patient from a Cohort, by voiding their membership. (Has no effect if the patient is not in the cohort.) (This behavior is provided for consistency with the pre-2.1.0 API, which didn't track cohort membership dates.)

Specified by:

removePatientFromCohort in interface CohortService

Parameters:

cohort - the cohort containing the given patient

patient - the patient to remove from the given cohort

Returns:

The cohort that was passed in with the patient removed

See Also:

CohortService.removePatientFromCohort(org.openmrs.Cohort, org.openmrs.Patient)

getCohortsContainingPatient

@Transactional(readOnly=true)
public List<Cohort> getCohortsContainingPatient(Patient patient)

Specified by:

getCohortsContainingPatient in interface CohortService

Parameters:

patient - patient used to find the cohorts

Returns:

All non-voided Cohorts that contain the given patient

getCohortsContainingPatientId

@Transactional(readOnly=true)
public List<Cohort> getCohortsContainingPatientId(Integer patientId)

Description copied from interface: CohortService

Find all Cohorts that contain the given patientId right now. (Not including voided Cohorts, or ended memberships)

Specified by:

getCohortsContainingPatientId in interface CohortService

Parameters:

patientId - patient id used to find the cohorts

Returns:

All non-voided Cohorts that contain the given patientId

getCohorts

@Transactional(readOnly=true)
public List<Cohort> getCohorts(String nameFragment)
                                                      throws APIException

Description copied from interface: CohortService

Returns Cohorts whose names match the given string. Returns an empty list in the case of no results. Returns all Cohorts in the case of null or empty input

Specified by:

getCohorts in interface CohortService

Returns:

list of cohorts matching the name fragment

Throws:

APIException - Should never return null Should match cohorts by partial name

See Also:

CohortService.getCohorts(java.lang.String)

getAllCohorts

@Transactional(readOnly=true)
public List<Cohort> getAllCohorts()
                                                         throws APIException

Description copied from interface: CohortService

Gets all Cohorts (not including voided ones)

Specified by:

getAllCohorts in interface CohortService

Returns:

All Cohorts in the database (not including voided ones)

Throws:

APIException - Should get all nonvoided cohorts in database Should not return any voided cohorts

See Also:

CohortService.getAllCohorts()

getAllCohorts

@Transactional(readOnly=true)
public List<Cohort> getAllCohorts(boolean includeVoided)
                                                         throws APIException

Description copied from interface: CohortService

Gets all Cohorts, possibly including the voided ones

Specified by:

getAllCohorts in interface CohortService

Parameters:

includeVoided - whether or not to include voided Cohorts

Returns:

All Cohorts, maybe including the voided ones

Throws:

APIException - Should return all cohorts and voided

See Also:

CohortService.getAllCohorts(boolean)

getCohortByName

@Transactional(readOnly=true)
public Cohort getCohortByName(String name)
                                                     throws APIException

Description copied from interface: CohortService

Gets a non voided Cohort by its name

Specified by:

getCohortByName in interface CohortService

Returns:

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

Throws:

APIException - Should get cohort given a name Should get the nonvoided cohort if two exist with same name Should only get non voided cohorts by name

See Also:

CohortService.getCohortByName(java.lang.String)

getCohort

@Transactional(readOnly=true)
public Cohort getCohort(String name)
                                               throws APIException

Specified by:

getCohort in interface CohortService

Throws:

APIException

See Also:

CohortService.getCohort(java.lang.String)

purgeCohort

public Cohort purgeCohort(Cohort cohort)
                   throws APIException

Description copied from interface: CohortService

Completely removes a Cohort from the database (not reversible)

Specified by:

purgeCohort in interface CohortService

Parameters:

cohort - the Cohort to completely remove from the database

Throws:

APIException - Should delete cohort from database

See Also:

CohortService.purgeCohort(org.openmrs.Cohort)

purgeCohortMembership

public void purgeCohortMembership(CohortMembership cohortMembership)
                           throws APIException

Description copied from interface: CohortService

Removes a CohortMembership from its parent Cohort

Specified by:

purgeCohortMembership in interface CohortService

Parameters:

cohortMembership - membership that will be removed from cohort

Throws:

APIException

See Also:

CohortService.purgeCohortMembership(CohortMembership)

voidCohortMembership

public CohortMembership voidCohortMembership(CohortMembership cohortMembership,
                                             String reason)

Description copied from interface: CohortService

Marks the specified CohortMembership as voided

Specified by:

voidCohortMembership in interface CohortService

Parameters:

cohortMembership - the CohortMembership to void

reason - void reason

Returns:

the voided CohortMembership

See Also:

CohortService.voidCohortMembership(CohortMembership, String)

endCohortMembership

public CohortMembership endCohortMembership(CohortMembership cohortMembership,
                                            Date onDate)

Description copied from interface: CohortService

Ends the specified CohortMembership i.e. sets its end date to the current date

Specified by:

endCohortMembership in interface CohortService

Parameters:

cohortMembership - the CohortMembership to end

onDate - when to end the membership (optional, defaults to now)

Returns:

the ended CohortMembership

See Also:

CohortService.endCohortMembership(CohortMembership, Date)

notifyPatientVoided

public void notifyPatientVoided(Patient patient)
                         throws APIException

Description copied from interface: CohortService

NOTE: CLIENT CODE SHOULD NEVER CALL THIS METHOD. TREAT THIS AS AN INTERNAL METHOD WHICH MAY CHANGE WITHOUT WARNING. Used to notify this service that a patient has been voided, and therefore we should void all cohort memberships that refer to that patient

Specified by:

notifyPatientVoided in interface CohortService

Parameters:

patient - patient that was voided Should void the membership for the patient that was passed in

Throws:

APIException

See Also:

CohortService.notifyPatientVoided(org.openmrs.Patient)

notifyPatientUnvoided

public void notifyPatientUnvoided(Patient patient,
                                  User originallyVoidedBy,
                                  Date originalDateVoided)
                           throws APIException

Description copied from interface: CohortService

NOTE: CLIENT CODE SHOULD NEVER CALL THIS METHOD. TREAT THIS AS AN INTERNAL METHOD WHICH MAY CHANGE WITHOUT WARNING. Used to notify this service that a patient has been unvoided, and therefore we should unvoid all cohort memberships that were automatically voided with the patient

Specified by:

notifyPatientUnvoided in interface CohortService

Parameters:

patient - patient that was unvoided

originalDateVoided - Should unvoid the membership for the patient that was passed in

Throws:

APIException

See Also:

CohortService.notifyPatientUnvoided(Patient, User, Date)

getCohortMemberships

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

Description copied from interface: CohortService

Gets memberships for the given patient, optionally active on a specific date

Specified by:

getCohortMemberships in interface CohortService

Returns:

matching memberships