org.openmrs

Class PatientProgram

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.PatientProgram

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, Customizable<PatientProgramAttribute>, OpenmrsData, OpenmrsObject, Voidable

public class PatientProgram
extends BaseChangeableOpenmrsData
implements Customizable<PatientProgramAttribute>

PatientProgram

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
PatientProgram() Default Constructor
PatientProgram(Integer patientProgramId) Constructor with id

Method Summary

Modifier and Type	Method and Description
void	addAttribute(PatientProgramAttribute attribute) Adds an attribute.
PatientProgram	copy() Does a mostly-shallow copy of this PatientProgram.
protected PatientProgram	copyHelper(PatientProgram target) The purpose of this method is to allow subclasses of PatientProgram to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.
boolean	getActive() Returns true if the associated Patient is currently enrolled in the associated Program
boolean	getActive(Date onDate) Returns true if the associated Patient is enrolled in the associated Program on the passed Date
Collection<PatientProgramAttribute>	getActiveAttributes()
List<PatientProgramAttribute>	getActiveAttributes(CustomValueDescriptor ofType)
Set<PatientProgramAttribute>	getAttributes()
PatientState	getCurrentState(ProgramWorkflow programWorkflow) Returns the current PatientState for the passed ProgramWorkflow within this PatientProgram.
Set<PatientState>	getCurrentStates() Returns a Set<PatientState> of all current PatientStates for the PatientProgram
Date	getDateCompleted()
Date	getDateEnrolled()
Integer	getId()
Location	getLocation()
Set<PatientState>	getMostRecentStateInEachWorkflow() Returns a Set<PatientState> of all recent PatientStates for each workflow of the PatientProgram
Concept	getOutcome()
Patient	getPatient()
Integer	getPatientProgramId()
PatientState	getPatientState(Integer patientStateId) Returns the PatientState associated with this PatientProgram that has an id that matches the passed patientStateId
Program	getProgram()
Set<PatientState>	getStates()
void	setAttribute(PatientProgramAttribute attribute)
void	setAttributes(Set<PatientProgramAttribute> attributes)
void	setDateCompleted(Date dateCompleted)
void	setDateEnrolled(Date dateEnrolled)
void	setId(Integer id)
void	setLocation(Location location)
void	setOutcome(Concept concept)
void	setPatient(Patient patient)
void	setPatientProgramId(Integer patientProgramId)
void	setProgram(Program program)
void	setStates(Set<PatientState> states)
List<PatientState>	statesInWorkflow(ProgramWorkflow programWorkflow, boolean includeVoided) Returns a List<PatientState> of all PatientStates in the passed ProgramWorkflow for the PatientProgram
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}
void	transitionToState(ProgramWorkflowState programWorkflowState, Date onDate) Attempts to transition the PatientProgram to the passed ProgramWorkflowState on the passed Date by ending the most recent PatientState in the PatientProgram and creating a new one with the passed ProgramWorkflowState This will throw an IllegalArgumentException if the transition is invalid
void	voidLastState(ProgramWorkflow workflow, User voidBy, Date voidDate, String voidReason) Attempts to void the latest PatientState in the PatientProgram If earlier PatientStates exist, it will try to reset the endDate to null so that the next latest state becomes the current PatientState

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

PatientProgram

public PatientProgram()

Default Constructor

PatientProgram

public PatientProgram(Integer patientProgramId)

Constructor with id

Method Detail

copy

public PatientProgram copy()

Does a mostly-shallow copy of this PatientProgram. Does not copy patientProgramId. The 'states' property will be deep-copied.

Returns:

a shallow copy of this PatientProgram

copyHelper

protected PatientProgram copyHelper(PatientProgram target)

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

Parameters:

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

Returns:

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

getActive

public boolean getActive(Date onDate)

Returns true if the associated Patient is enrolled in the associated Program on the passed Date

Parameters:

onDate - - Date to check for PatientProgram enrollment

Returns:

boolean - true if the associated Patient is enrolled in the associated Program on the passed Date

getActive

public boolean getActive()

Returns true if the associated Patient is currently enrolled in the associated Program

Returns:

boolean - true if the associated Patient is currently enrolled in the associated Program

getPatientState

public PatientState getPatientState(Integer patientStateId)

Returns the PatientState associated with this PatientProgram that has an id that matches the passed patientStateId

Parameters:

patientStateId - - The identifier to use to lookup a PatientState

Returns:

PatientState that has an id that matches the passed patientStateId

transitionToState

public void transitionToState(ProgramWorkflowState programWorkflowState,
                              Date onDate)

Attempts to transition the PatientProgram to the passed ProgramWorkflowState on the passed Date by ending the most recent PatientState in the PatientProgram and creating a new one with the passed ProgramWorkflowState This will throw an IllegalArgumentException if the transition is invalid

Parameters:

programWorkflowState - - The ProgramWorkflowState to transition to

onDate - - The Date of the transition

Throws:

IllegalArgumentException

voidLastState

public void voidLastState(ProgramWorkflow workflow,
                          User voidBy,
                          Date voidDate,
                          String voidReason)

Attempts to void the latest PatientState in the PatientProgram If earlier PatientStates exist, it will try to reset the endDate to null so that the next latest state becomes the current PatientState

Parameters:

workflow - - The ProgramWorkflow whose last PatientState within the current PatientProgram we want to void

voidBy - - The user who is voiding the PatientState

voidDate - - The date to void the PatientState

voidReason - - The reason for voiding the PatientState Should void state with endDate null if startDates equal

getCurrentState

public PatientState getCurrentState(ProgramWorkflow programWorkflow)

Returns the current PatientState for the passed ProgramWorkflow within this PatientProgram.

Parameters:

programWorkflow - The ProgramWorkflow whose current PatientState we want to retrieve

Returns:

PatientState The current PatientState for the passed ProgramWorkflow within this PatientProgram

getCurrentStates

public Set<PatientState> getCurrentStates()

Returns a Set<PatientState> of all current PatientStates for the PatientProgram

Returns:

Set<PatientState> of all current PatientStates for the PatientProgram

getMostRecentStateInEachWorkflow

public Set<PatientState> getMostRecentStateInEachWorkflow()

Returns a Set<PatientState> of all recent PatientStates for each workflow of the PatientProgram

Returns:

Set<PatientState> of all recent PatientStates for the PatientProgram

statesInWorkflow

public List<PatientState> statesInWorkflow(ProgramWorkflow programWorkflow,
                                           boolean includeVoided)

Returns a List<PatientState> of all PatientStates in the passed ProgramWorkflow for the PatientProgram

Parameters:

programWorkflow - - The ProgramWorkflow to check

includeVoided - - If true, return voided PatientStates in the returned List

Returns:

List<PatientState> of all PatientStates in the passed ProgramWorkflow for the PatientProgram

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()

getOutcome

public Concept getOutcome()

setOutcome

public void setOutcome(Concept concept)

getDateCompleted

public Date getDateCompleted()

setDateCompleted

public void setDateCompleted(Date dateCompleted)

getDateEnrolled

public Date getDateEnrolled()

setDateEnrolled

public void setDateEnrolled(Date dateEnrolled)

getPatient

public Patient getPatient()

setPatient

public void setPatient(Patient patient)

getPatientProgramId

public Integer getPatientProgramId()

setPatientProgramId

public void setPatientProgramId(Integer patientProgramId)

getProgram

public Program getProgram()

setProgram

public void setProgram(Program program)

getStates

public Set<PatientState> getStates()

setStates

public void setStates(Set<PatientState> states)

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)

getLocation

public Location getLocation()

Returns:

the location

Since:

1.8

setLocation

public void setLocation(Location location)

Parameters:

location - the location to set

Since:

1.8

getAttributes

public Set<PatientProgramAttribute> getAttributes()

Specified by:

getAttributes in interface Customizable<PatientProgramAttribute>

Returns:

all attributes (including voided ones)

getActiveAttributes

public Collection<PatientProgramAttribute> getActiveAttributes()

Specified by:

getActiveAttributes in interface Customizable<PatientProgramAttribute>

Returns:

non-voided attributes

getActiveAttributes

public List<PatientProgramAttribute> getActiveAttributes(CustomValueDescriptor ofType)

Specified by:

getActiveAttributes in interface Customizable<PatientProgramAttribute>

Returns:

non-voided attributes of the given type

addAttribute

public void addAttribute(PatientProgramAttribute attribute)

Description copied from interface: Customizable

Adds an attribute.

Specified by:

addAttribute in interface Customizable<PatientProgramAttribute>

setAttributes

public void setAttributes(Set<PatientProgramAttribute> attributes)

setAttribute

public void setAttribute(PatientProgramAttribute attribute)