org.openmrs

Interface FormRecordable

All Known Implementing Classes:

Allergy, BaseFormRecordableOpenmrsData, Condition, Diagnosis, DrugOrder, MedicationDispense, Obs, Order, PatientState, ReferralOrder, ServiceOrder, TestOrder

public interface FormRecordable

Defines the methods to make a bridge between an OpenMrsObject and is position in the form.

Since:

2.4.0

Method Summary

Modifier and Type	Method and Description
String	getFormFieldNamespace() Gets the namespace for the form field that was used to capture the obs details in the form
String	getFormFieldPath() Gets the path for the form field that was used to capture the obs details in the form
void	setFormField(String namespace, String formFieldPath) Sets the namespace and path of the form field that was used to capture the obs details in the form.

Method Detail

getFormFieldNamespace

String getFormFieldNamespace()

Gets the namespace for the form field that was used to capture the obs details in the form

Returns:

the namespace

Since:

2.4.0 Should return the namespace for a form field that has no path Should return the correct namespace for a form field with a path Should return null if the namespace is not specified

getFormFieldPath

String getFormFieldPath()

Gets the path for the form field that was used to capture the obs details in the form

Returns:

the the form field path

Since:

2.4.0 Should return the path for a form field that has no namespace Should return the correct path for a form field with a namespace Should return null if the path is not specified

setFormField

void setFormField(String namespace,
                  String formFieldPath)

Sets the namespace and path of the form field that was used to capture the obs details in the form.
Note: Namespace and formFieldPath together must not exceed 254 characters in length, form applications can subtract the length of their namespace from 254 to determine the maximum length they can use for a form field path.

Parameters:

namespace - the namespace of the form field

formFieldPath - the path of the form field

Since:

2.4.0 Should set the underlying formNamespaceAndPath in the correct pattern Should reject a namepace containing the separator Should reject a path containing the separator Should reject a namepace and path combination longer than the max length Should not mark the obs as dirty when the value has not been changed Should mark the obs as dirty when the value has been changed Should mark the obs as dirty when the value is changed from a null to a non null value Should mark the obs as dirty when the value is changed from a non null to a null value