org.openmrs

Class Form

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.BaseChangeableOpenmrsMetadata

org.openmrs.Form

All Implemented Interfaces:

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

public class Form
extends BaseChangeableOpenmrsMetadata

Form

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Form() default constructor
Form(Integer formId) Constructor with id Should set formId with given parameter

Method Summary

Modifier and Type	Method and Description
void	addFormField(FormField formField) Adds a FormField to the list of form fields
Integer	getBuild()
EncounterType	getEncounterType()
Set<FormField>	getFormFields()
Integer	getFormId()
Integer	getId()
List<FormField>	getOrderedFormFields()
Boolean	getPublished()
String	getVersion()
void	removeFormField(FormField formField) Removes a FormField from the list of form fields
void	setBuild(Integer build)
void	setEncounterType(EncounterType encounterType)
void	setFormFields(Set<FormField> formFields)
void	setFormId(Integer formId)
void	setId(Integer id)
void	setPublished(Boolean published)
void	setVersion(String version)
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

Form

public Form()

default constructor

Form

public Form(Integer formId)

Constructor with id Should set formId with given parameter

Method Detail

getFormId

public Integer getFormId()

Returns:

Returns the formId.

setFormId

public void setFormId(Integer formId)

Parameters:

formId - The formId to set.

getVersion

public String getVersion()

Returns:

Returns the version.

setVersion

public void setVersion(String version)

Parameters:

version - The version to set.

getBuild

public Integer getBuild()

Returns:

Returns the build number

setBuild

public void setBuild(Integer build)

Parameters:

build - The build number to set

getPublished

public Boolean getPublished()

Returns:

Returns the published.

setPublished

public void setPublished(Boolean published)

Parameters:

published - The published to set.

getEncounterType

public EncounterType getEncounterType()

Returns:

the type of encounter associated with this form

setEncounterType

public void setEncounterType(EncounterType encounterType)

Parameters:

encounterType - type of encounter associated with this form

getFormFields

public Set<FormField> getFormFields()

Returns:

Returns the formFields.

getOrderedFormFields

public List<FormField> getOrderedFormFields()

Returns:

Returns the formFields.

setFormFields

public void setFormFields(Set<FormField> formFields)

Parameters:

formFields - The formFields to set.

addFormField

public void addFormField(FormField formField)

Adds a FormField to the list of form fields

Parameters:

formField - FormField to be added

removeFormField

public void removeFormField(FormField formField)

Removes a FormField from the list of form fields

Parameters:

formField - FormField to be removed

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

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)