org.openmrs

Class Form

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.Form

All Implemented Interfaces:

java.io.Serializable, Auditable, OpenmrsMetadata, OpenmrsObject, Retireable

public class Form
extends BaseOpenmrsMetadata
implements java.io.Serializable

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(java.lang.Integer formId) Constructor with id

Method Summary

Modifier and Type	Method and Description
void	addFormField(FormField formField) Adds a FormField to the list of form fields
java.lang.Integer	getBuild()
EncounterType	getEncounterType()
java.util.Set<FormField>	getFormFields()
java.lang.Integer	getFormId()
java.lang.Integer	getId()
java.util.List<FormField>	getOrderedFormFields()
java.lang.Boolean	getPublished()
java.lang.String	getRetiredReason() Deprecated. use BaseOpenmrsMetadata.getRetireReason()
java.lang.String	getTemplate() Deprecated.
java.lang.String	getVersion()
java.lang.String	getXslt() Deprecated.
void	removeFormField(FormField formField) Removes a FormField from the list of form fields
void	setBuild(java.lang.Integer build)
void	setEncounterType(EncounterType encounterType)
void	setFormFields(java.util.Set<FormField> formFields)
void	setFormId(java.lang.Integer formId)
void	setId(java.lang.Integer id)
void	setPublished(java.lang.Boolean published)
void	setRetiredReason(java.lang.String reason) Deprecated. use BaseOpenmrsMetadata.setRetireReason(String)
void	setTemplate(java.lang.String template) Deprecated.
void	setVersion(java.lang.String version)
void	setXslt(java.lang.String xslt) Deprecated.
java.lang.String	toString() Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ].

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(java.lang.Integer formId)

Constructor with id

Method Detail

getFormId

public java.lang.Integer getFormId()

Returns:

Returns the formId.

setFormId

public void setFormId(java.lang.Integer formId)

Parameters:

formId - The formId to set.

getVersion

public java.lang.String getVersion()

Returns:

Returns the version.

setVersion

public void setVersion(java.lang.String version)

Parameters:

version - The version to set.

getBuild

public java.lang.Integer getBuild()

Returns:

Returns the build number

setBuild

public void setBuild(java.lang.Integer build)

Parameters:

build - The build number to set

getPublished

public java.lang.Boolean getPublished()

Returns:

Returns the published.

setPublished

public void setPublished(java.lang.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

getTemplate

@Deprecated
public java.lang.String getTemplate()

Deprecated.

Returns:

Returns the template.

setTemplate

@Deprecated
public void setTemplate(java.lang.String template)

Deprecated.

Parameters:

template - The template to set.

getXslt

@Deprecated
public java.lang.String getXslt()

Deprecated.

Returns:

Returns the creator

setXslt

@Deprecated
public void setXslt(java.lang.String xslt)

Deprecated.

Parameters:

xslt - the xslt to set.

getFormFields

public java.util.Set<FormField> getFormFields()

Returns:

Returns the formFields.

getOrderedFormFields

public java.util.List<FormField> getOrderedFormFields()

Returns:

Returns the formFields.

setFormFields

public void setFormFields(java.util.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 java.lang.String toString()

Description copied from class: BaseOpenmrsObject

Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ]. In other words, this method returns a string equal to the value of:

 getClass().getName() + '[' + uuid + ']'
 

If the uuid field is null, it delegates to Object.toString()

Overrides:

toString in class BaseOpenmrsObject

See Also:

Object.toString()

getId

public java.lang.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(java.lang.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)

setRetiredReason

@Deprecated
public void setRetiredReason(java.lang.String reason)

Deprecated. use BaseOpenmrsMetadata.setRetireReason(String)

getRetiredReason

@Deprecated
public java.lang.String getRetiredReason()

Deprecated. use BaseOpenmrsMetadata.getRetireReason()