org.openmrs

Class CohortMembership

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.CohortMembership

All Implemented Interfaces:

Serializable, Comparable<CohortMembership>, Auditable, Changeable, Creatable, OpenmrsData, OpenmrsObject, Voidable

public class CohortMembership
extends BaseChangeableOpenmrsData
implements Comparable<CohortMembership>

Since:

2.1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
CohortMembership()
CohortMembership(Integer patientId)
CohortMembership(Integer patientId, Date startDate)

Method Summary

Modifier and Type	Method and Description
int	compareTo(CohortMembership o) Sorts by following fields, in order: voided (voided memberships sort last) endDate descending (so ended memberships are towards the end, and the older the more towards the end startDate descending (so started more recently is towards the front) patientId ascending (intuitive and consistent tiebreaker for client code) uuid ascending (just so we have a final consistent tie breaker)
boolean	equals(Object otherCohortMembershipObject) Returns true if and only if x and y refer to the same object (x == y has the value true) or both have the same uuid (((x.uuid !
Cohort	getCohort()
Integer	getCohortMemberId()
Date	getEndDate()
Integer	getId()
Integer	getPatientId()
Date	getStartDate()
int	hashCode() Returns a hash code based on the uuid field.
boolean	isActive()
boolean	isActive(Date asOfDate) Compares asOfDate to [startDate, endDate], inclusive of both endpoints.
void	setCohort(Cohort cohort)
void	setCohortMemberId(Integer cohortMemberId)
void	setEndDate(Date endDate) OpenMRS treats a membership as active from its startDate to endDate inclusive of both.
void	setId(Integer id)
void	setPatientId(Integer patientId)
void	setStartDate(Date startDate)

Methods inherited from class org.openmrs.BaseOpenmrsData

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

getUuid, setUuid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject

getUuid, setUuid

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

CohortMembership

public CohortMembership()

CohortMembership

public CohortMembership(Integer patientId,
                        Date startDate)

CohortMembership

public CohortMembership(Integer patientId)

Method Detail

isActive

public boolean isActive(Date asOfDate)

Compares asOfDate to [startDate, endDate], inclusive of both endpoints.

Parameters:

asOfDate - date to compare if membership is active or inactive

Returns:

boolean true/false if membership is active/inactive

isActive

public boolean isActive()

getId

public Integer getId()

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

setId

public void setId(Integer id)

Specified by:

setId in interface OpenmrsObject

Parameters:

id - - The unique Identifier for the object

getCohortMemberId

public Integer getCohortMemberId()

setCohortMemberId

public void setCohortMemberId(Integer cohortMemberId)

getCohort

public Cohort getCohort()

setCohort

public void setCohort(Cohort cohort)

getPatientId

public Integer getPatientId()

setPatientId

public void setPatientId(Integer patientId)

getStartDate

public Date getStartDate()

setStartDate

public void setStartDate(Date startDate)

getEndDate

public Date getEndDate()

setEndDate

public void setEndDate(Date endDate)

OpenMRS treats a membership as active from its startDate to endDate inclusive of both. The underlying database field stores a date+time, so in the common case (where you don't care about the time of day that cohort membership ended) you want to set the time component to 23:59:59.

Parameters:

endDate -

compareTo

public int compareTo(CohortMembership o)

Sorts by following fields, in order:

1. voided (voided memberships sort last)
2. endDate descending (so ended memberships are towards the end, and the older the more towards the end
3. startDate descending (so started more recently is towards the front)
4. patientId ascending (intuitive and consistent tiebreaker for client code)
5. uuid ascending (just so we have a final consistent tie breaker)

Specified by:

compareTo in interface Comparable<CohortMembership>

Parameters:

o - other membership to compare this to

Returns:

value greater than 0 if this is not voided and o is voided; or value less than 0 if this is voided and o is not voided; if both is voided or not then value greater than 0 if o.getEndDate() return null; or value less than 0 if this.getEndDate() return null; if both are null or not then value greater than 0 if this.getEndDate() is before o.getEndDate(); or value less than 0 if this.getEndDate() is after o.getEndDate(); if are equal then value greater than 0 if this.getStartDate() return null; or value less than 0 if o.getStartDate() return null; if both are null or not then value greater than 0 if this.getStartDate() is before o.getStartDate(); or value less than 0 if this.getStartDate() is after o.getStartDate(); if are equal then value greater than 0 if o.getPatientId() is greater than this.getPatientId(); or value less than 0 if o.getPatientId() is less than this.getPatientId(); if are equal then value greater than 0 if o.getUuid() is greater than this.getUuid(); or value less than 0 if o.getUuid() is less than this.getUuid(); or 0 if are equal

equals

public boolean equals(Object otherCohortMembershipObject)

Description copied from class: BaseOpenmrsObject

Returns true if and only if x and y refer to the same object (x == y has the value true) or both have the same uuid (((x.uuid != null) && x.uuid.equals(y.uuid)) has the value true).

Overrides:

equals in class BaseOpenmrsObject

Parameters:

otherCohortMembershipObject - is a CohortMembership object that should be checked for equality with this object

Returns:

true if both objects are logically equal. This is the case when endDate, startDate and patientId are equal

Since:

2.3.0 Indicates if a given cohortMembership object is equal to this one

See Also:

Should return false if given obj is not instance of BaseOpenmrsObject Should return false if given obj is null Should return false if given obj has null uuid Should return false if uuid is null Should return true if objects are the same Should return true if uuids are equal

hashCode

public int hashCode()

Description copied from class: BaseOpenmrsObject

Returns a hash code based on the uuid field.

If the uuid field is null, it delegates to Object.hashCode().

Overrides:

hashCode in class BaseOpenmrsObject

Since:

2.3.0 Creates a hash code of this object

See Also:

Should not fail if uuid is null