org.openmrs
Class Form

java.lang.Object
  extended by org.openmrs.BaseOpenmrsObject
      extended by org.openmrs.BaseOpenmrsMetadata
          extended by 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
static long serialVersionUID
           
 
Constructor Summary
Form()
          default constructor
Form(java.lang.Integer formId)
          Constructor with id
 
Method Summary
 void addFormField(FormField formField)
          Adds a FormField to the list of form fields
 boolean equals(java.lang.Object obj)
          Compares two objects for similarity
 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()
           
 java.lang.String getVersion()
           
 java.lang.String getXslt()
           
 int hashCode()
           
 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)
           
 void setVersion(java.lang.String version)
           
 void setXslt(java.lang.String xslt)
           
 java.lang.String toString()
           
 
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
getUuid, 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

Expected behavior:
set formId with given parameter
Method Detail

equals

public boolean equals(java.lang.Object obj)
Compares two objects for similarity

Overrides:
equals in class java.lang.Object
Parameters:
obj -
Returns:
boolean true/false whether or not they are the same objects
Expected behavior:
have equal form objects by form id, not have equal form objects by formId, have equal form objects with no formId, not have equal form objects when one has null formId

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
See Also:
Object.hashCode()
Expected behavior:
get hashCode even with null attributes

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

public java.lang.String getTemplate()
Returns:
Returns the template.

setTemplate

public void setTemplate(java.lang.String template)
Parameters:
template - The template to set.

getXslt

public java.lang.String getXslt()
Returns:
Returns the creator

setXslt

public void setXslt(java.lang.String xslt)

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()
Overrides:
toString in class java.lang.Object

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

public void setRetiredReason(java.lang.String reason)
Deprecated. use BaseOpenmrsMetadata.setRetireReason(String)


getRetiredReason

public java.lang.String getRetiredReason()
Deprecated. use BaseOpenmrsMetadata.getRetireReason()


OpenMRS-1.7.x

Generated Apr 27 2012 10:06 PM. NOTE - these libraries are in active development and subject to change