org.openmrs

Class Program

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.BaseChangeableOpenmrsMetadata

org.openmrs.Program

All Implemented Interfaces:

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

public class Program
extends BaseChangeableOpenmrsMetadata

Program

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Program() Default Constructor
Program(Integer programId) Constructor with id
Program(String name) Constructor with name

Method Summary

Modifier and Type	Method and Description
void	addWorkflow(ProgramWorkflow workflow) Adds a new ProgramWorkflow to this Program
Set<ProgramWorkflow>	getAllWorkflows() Get all workflows...including the retired ones
Concept	getConcept()
Integer	getId()
Concept	getOutcomesConcept()
Integer	getProgramId()
ProgramWorkflow	getWorkflow(Integer programWorkflowId) Get the workflow with the specified ID
ProgramWorkflow	getWorkflowByName(String name) Returns a ProgramWorkflow whose Concept has any ConceptName that matches the given name
Set<ProgramWorkflow>	getWorkflows() Get only the non-retired workflows
void	removeWorkflow(ProgramWorkflow workflow) Removes a ProgramWorkflow from this Program
void	retireWorkflow(ProgramWorkflow workflow) Retires a ProgramWorkflow
void	setAllWorkflows(Set<ProgramWorkflow> allWorkflows)
void	setConcept(Concept concept)
void	setId(Integer id)
void	setOutcomesConcept(Concept concept)
void	setProgramId(Integer programId)
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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Program

public Program()

Default Constructor

Program

public Program(Integer programId)

Constructor with id

Program

public Program(String name)

Constructor with name

Since:

1.10

Method Detail

addWorkflow

public void addWorkflow(ProgramWorkflow workflow)

Adds a new ProgramWorkflow to this Program

Parameters:

workflow - - the ProgramWorkflow to add

removeWorkflow

public void removeWorkflow(ProgramWorkflow workflow)

Removes a ProgramWorkflow from this Program

Parameters:

workflow - - the ProgramWorkflow to remove

retireWorkflow

public void retireWorkflow(ProgramWorkflow workflow)

Retires a ProgramWorkflow

Parameters:

workflow - - the ProgramWorkflow to retire

getWorkflowByName

public ProgramWorkflow getWorkflowByName(String name)

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

Parameters:

name - the ProgramWorkflow name, in any Locale

Returns:

a ProgramWorkflow which has the passed name in any Locale

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

getConcept

public Concept getConcept()

setConcept

public void setConcept(Concept concept)

getOutcomesConcept

public Concept getOutcomesConcept()

setOutcomesConcept

public void setOutcomesConcept(Concept concept)

getProgramId

public Integer getProgramId()

setProgramId

public void setProgramId(Integer programId)

getWorkflows

public Set<ProgramWorkflow> getWorkflows()

Get only the non-retired workflows

Returns:

Returns a Set<ProgramWorkflow> of all non-retired workflows

getWorkflow

public ProgramWorkflow getWorkflow(Integer programWorkflowId)

Get the workflow with the specified ID

Returns:

the workflow matching the given id or null if none found

Since:

1.6

getAllWorkflows

public Set<ProgramWorkflow> getAllWorkflows()

Get all workflows...including the retired ones

Returns:

Returns a Set<ProgramWorkflow> of all workflows

setAllWorkflows

public void setAllWorkflows(Set<ProgramWorkflow> allWorkflows)

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)