org.openmrs

Class PatientState

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.BaseFormRecordableOpenmrsData

org.openmrs.PatientState

All Implemented Interfaces:

Serializable, Comparable<PatientState>, Auditable, Changeable, Creatable, FormRecordable, OpenmrsData, OpenmrsObject, Voidable

@Entity
public class PatientState
extends BaseFormRecordableOpenmrsData
implements Serializable, Comparable<PatientState>

PatientState

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class org.openmrs.BaseFormRecordableOpenmrsData

FORM_NAMESPACE_PATH_MAX_LENGTH, FORM_NAMESPACE_PATH_SEPARATOR, formNamespaceAndPath

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
PatientState() Default Constructor
PatientState(Integer patientStateId) Constructor with id

Method Summary

Modifier and Type	Method and Description
int	compareTo(PatientState o) Compares by startDate with null as earliest and endDate with null as latest.
PatientState	copy() Does a shallow copy of this PatientState.
protected PatientState	copyHelper(PatientState target) The purpose of this method is to allow subclasses of PatientState to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.
boolean	getActive() Returns true if this PatientState is currently active
boolean	getActive(Date onDate) Returns true if this PatientState is active as of the passed Date
Encounter	getEncounter()
Date	getEndDate()
Integer	getId()
PatientProgram	getPatientProgram()
Integer	getPatientStateId()
Date	getStartDate()
ProgramWorkflowState	getState()
void	setEncounter(Encounter encounter)
void	setEndDate(Date endDate)
void	setId(Integer id)
void	setPatientProgram(PatientProgram patientProgram)
void	setPatientStateId(Integer patientStatusId)
void	setStartDate(Date startDate)
void	setState(ProgramWorkflowState state)
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseFormRecordableOpenmrsData

getFormFieldNamespace, getFormFieldNamespace, getFormFieldPath, getFormFieldPath, getFormNamespaceAndPath, getFormNamespaceAndPath, setFormField, setFormNamespaceAndPath

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

equals, getUuid, hashCode, setUuid

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

PatientState

public PatientState()

Default Constructor

PatientState

public PatientState(Integer patientStateId)

Constructor with id

Method Detail

copy

public PatientState copy()

Does a shallow copy of this PatientState. Does NOT copy patientStateId

Returns:

a copy of this PatientState

copyHelper

protected PatientState copyHelper(PatientState target)

The purpose of this method is to allow subclasses of PatientState to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.

Parameters:

target - a PatientState that will have the state of this copied into it

Returns:

the PatientState that was passed in, with state copied into it

getActive

public boolean getActive(Date onDate)

Returns true if this PatientState is active as of the passed Date

Parameters:

onDate - - Date to check for PatientState enrollment

Returns:

boolean - true if this PatientState is active as of the passed Date Should return false if voided and date in range Should return false if voided and date not in range Should return true if not voided and date in range Should return false if not voided and date earlier than startDate Should return false if not voided and date later than endDate Should return true if not voided and date in range with null startDate Should return true if not voided and date in range with null endDate Should return true if not voided and both startDate and endDate nulled Should compare with current date if date null

getActive

public boolean getActive()

Returns true if this PatientState is currently active

Returns:

boolean - true if this PatientState is currently active

toString

public String toString()

Description copied from class: BaseOpenmrsObject

Returns a string equal to the value of:

ClassName{hashCode=..., uuid=...}

If the uuid field is null, it returns:

ClassName{hashCode=...}

Should include hashCode if uuid is null Should include uuid if not null

Overrides:

toString in class BaseOpenmrsObject

See Also:

Object.toString()

getPatientProgram

public PatientProgram getPatientProgram()

setPatientProgram

public void setPatientProgram(PatientProgram patientProgram)

getPatientStateId

public Integer getPatientStateId()

setPatientStateId

public void setPatientStateId(Integer patientStatusId)

getState

public ProgramWorkflowState getState()

setState

public void setState(ProgramWorkflowState state)

getEndDate

public Date getEndDate()

setEndDate

public void setEndDate(Date endDate)

getStartDate

public Date getStartDate()

setStartDate

public void setStartDate(Date startDate)

getEncounter

public Encounter getEncounter()

Returns:

encounter - the associated encounter

Since:

2.5

setEncounter

public void setEncounter(Encounter encounter)

Parameters:

encounter - - the encounter to set

Since:

2.5

getId

public Integer getId()

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.getId()

setId

public void setId(Integer id)

Specified by:

setId in interface OpenmrsObject

Parameters:

id - - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.setId(java.lang.Integer)

compareTo

public int compareTo(PatientState o)

Compares by startDate with null as earliest and endDate with null as latest.

Specified by:

compareTo in interface Comparable<PatientState>

See Also:

Should return positive if startDates equal and this endDate null Should return negative if this startDate null Should pass if two states have the same start date, end date and uuid Should return positive or negative if two states have the same start date and end date but different uuids Note: this comparator imposes orderings that are inconsistent with equals.