org.openmrs

Class ProgramWorkflow

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.BaseChangeableOpenmrsMetadata

org.openmrs.ProgramWorkflow

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, OpenmrsMetadata, OpenmrsObject, Retireable

public class ProgramWorkflow
extends BaseChangeableOpenmrsMetadata

ProgramWorkflow

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProgramWorkflow() Default Constructor
ProgramWorkflow(Integer programWorkflowId) Constructor with id

Method Summary

Modifier and Type	Method and Description
void	addState(ProgramWorkflowState state) Adds a new ProgramWorkflowState to this ProgramWorkflow
Concept	getConcept()
Integer	getId()
int	getNonRetiredStateCount() Gets the number of states which are not retired
List<ProgramWorkflowState>	getPossibleNextStates(PatientProgram patientProgram) Returns a List<ProgramWorkflowState> including all possible next ProgramWorkflowStates, for the passed PatientProgram ordered by ConceptName
Program	getProgram()
Integer	getProgramWorkflowId()
Set<ProgramWorkflowState>	getSortedStates() Returns a Set<ProgramWorkflowState> including all ProgramWorkflowStates, sorted by ConceptName
ProgramWorkflowState	getState(Concept concept) Returns a ProgramWorkflowState whose Concept matches the passed concept
ProgramWorkflowState	getState(Integer programWorkflowStateId) Returns a ProgramWorkflowState whose primary key id matches the input parameter
ProgramWorkflowState	getState(String name) Returns a ProgramWorkflowState whose Concept name matches the passed name in any Locale
ProgramWorkflowState	getStateByName(String name) Returns a ProgramWorkflowState whose Concept has any ConceptName that matches the given name
Set<ProgramWorkflowState>	getStates()
Set<ProgramWorkflowState>	getStates(boolean includeRetired) Returns a Set<ProgramWorkflowState> including all non-retired ProgramWorkflowStates and all retired ProgramWorkflowStates in this ProgramWorkflow if includeRetired is true
boolean	isLegalTransition(ProgramWorkflowState fromState, ProgramWorkflowState toState) Check whether it is allowable to transition from fromState to toState.
void	removeState(ProgramWorkflowState state) Removes a ProgramWorkflowState from this ProgramWorkflow
void	retireState(ProgramWorkflowState state) Retires a ProgramWorkflowState
void	setConcept(Concept concept)
void	setId(Integer id)
void	setProgram(Program program)
void	setProgramWorkflowId(Integer programWorkflowId)
void	setStates(Set<ProgramWorkflowState> states)
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseOpenmrsMetadata

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateRetired, getDescription, getName, getRetired, getRetiredBy, getRetireReason, isRetired, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateRetired, setDescription, setName, setRetired, setRetiredBy, setRetireReason

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

Constructor Detail

ProgramWorkflow

public ProgramWorkflow()

Default Constructor

ProgramWorkflow

public ProgramWorkflow(Integer programWorkflowId)

Constructor with id

Method Detail

addState

public void addState(ProgramWorkflowState state)

Adds a new ProgramWorkflowState to this ProgramWorkflow

Parameters:

state - - the ProgramWorkflowState to add

removeState

public void removeState(ProgramWorkflowState state)

Removes a ProgramWorkflowState from this ProgramWorkflow

Parameters:

state - - the ProgramWorkflowState to remove

retireState

public void retireState(ProgramWorkflowState state)

Retires a ProgramWorkflowState

Parameters:

state - - the ProgramWorkflowState to retire

getState

public ProgramWorkflowState getState(Integer programWorkflowStateId)

Returns a ProgramWorkflowState whose primary key id matches the input parameter

Parameters:

programWorkflowStateId - the primary key Integer id to match

Returns:

a ProgramWorkflowState whose identifier matches the passed programWorkflowStateId

getState

public ProgramWorkflowState getState(Concept concept)

Returns a ProgramWorkflowState whose Concept matches the passed concept

Parameters:

concept - the Concept to match

Returns:

Returns a ProgramWorkflowState whose Concept matches the passed concept

getState

public ProgramWorkflowState getState(String name)

Returns a ProgramWorkflowState whose Concept name matches the passed name in any Locale

Parameters:

name - the Concept name to match in any Locale

Returns:

a ProgramWorkflowState whose Concept name matches the passed name

getStateByName

public ProgramWorkflowState getStateByName(String name)

Returns a ProgramWorkflowState whose Concept has any ConceptName that matches the given name

Parameters:

name - the ProgramWorkflowState name, in any Locale

Returns:

a ProgramWorkflowState which has the passed name in any Locale

getStates

public Set<ProgramWorkflowState> getStates(boolean includeRetired)

Returns a Set<ProgramWorkflowState> including all non-retired ProgramWorkflowStates and all retired ProgramWorkflowStates in this ProgramWorkflow if includeRetired is true

Parameters:

includeRetired - - if false, returns only non-retired ProgramWorkflowState objects in this ProgramWorkflow

Returns:

Set<ProgramWorkflowState> - all ProgramWorkflowStates matching input parameters

getSortedStates

public Set<ProgramWorkflowState> getSortedStates()

Returns a Set<ProgramWorkflowState> including all ProgramWorkflowStates, sorted by ConceptName

Returns:

Set<ProgramWorkflowState> - all ProgramWorkflowStates, sorted by ConceptName Should sort names containing numbers intelligently

getPossibleNextStates

public List<ProgramWorkflowState> getPossibleNextStates(PatientProgram patientProgram)

Returns a List<ProgramWorkflowState> including all possible next ProgramWorkflowStates, for the passed PatientProgram ordered by ConceptName

Parameters:

patientProgram - - The PatientProgram to check

Returns:

List<ProgramWorkflowState> - all possible next ProgramWorkflowStates, for the passed PatientProgram ordered by ConceptName

isLegalTransition

public boolean isLegalTransition(ProgramWorkflowState fromState,
                                 ProgramWorkflowState toState)

Check whether it is allowable to transition from fromState to toState.

Parameters:

fromState - ProgramWorkflowState to check transition from

toState - ProgramWorkflowState to check transition to

Returns:

boolean true if it is allowable to transition from fromState to toState

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

getStates

public Set<ProgramWorkflowState> getStates()

setStates

public void setStates(Set<ProgramWorkflowState> states)

getConcept

public Concept getConcept()

setConcept

public void setConcept(Concept concept)

getProgram

public Program getProgram()

setProgram

public void setProgram(Program program)

getProgramWorkflowId

public Integer getProgramWorkflowId()

setProgramWorkflowId

public void setProgramWorkflowId(Integer programWorkflowId)

getId

public Integer getId()

Returns:

id - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.getId()

setId

public void setId(Integer id)

Parameters:

id - - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.setId(java.lang.Integer)

getNonRetiredStateCount

public int getNonRetiredStateCount()

Gets the number of states which are not retired

Returns:

the total number of non retired states

Since:

1.9