org.openmrs

Class BaseFormRecordableOpenmrsData

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.BaseFormRecordableOpenmrsData

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, FormRecordable, OpenmrsData, OpenmrsObject, Voidable

Direct Known Subclasses:

Allergy, Condition, MedicationDispense, Obs, PatientState

@MappedSuperclass
public abstract class BaseFormRecordableOpenmrsData
extends BaseChangeableOpenmrsData
implements FormRecordable

Base implementation of FormRecordable that bridges between a saved BaseChangeableOpenmrsData entity and the path in a form where it was recorded.

Since:

2.4.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	FORM_NAMESPACE_PATH_MAX_LENGTH
protected static String	FORM_NAMESPACE_PATH_SEPARATOR
protected String	formNamespaceAndPath

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
BaseFormRecordableOpenmrsData()

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
static String	getFormFieldNamespace(String formNamespaceAndPath)
String	getFormFieldPath() Gets the path for the form field that was used to capture the obs details in the form
static String	getFormFieldPath(String formNamespaceAndPath)
String	getFormNamespaceAndPath()
static String	getFormNamespaceAndPath(String namespace, String formFieldPath)
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.
void	setFormNamespaceAndPath(String formNamespaceAndPath) Setter method

Methods inherited from class org.openmrs.BaseOpenmrsData

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject

getId, getUuid, setId, setUuid

Field Detail

FORM_NAMESPACE_PATH_SEPARATOR

protected static final String FORM_NAMESPACE_PATH_SEPARATOR

See Also:

Constant Field Values

FORM_NAMESPACE_PATH_MAX_LENGTH

protected static final int FORM_NAMESPACE_PATH_MAX_LENGTH

See Also:

Constant Field Values

formNamespaceAndPath

protected String formNamespaceAndPath

Constructor Detail

BaseFormRecordableOpenmrsData

public BaseFormRecordableOpenmrsData()

Method Detail

getFormFieldNamespace

public String getFormFieldNamespace()

Description copied from interface: FormRecordable

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

Specified by:

getFormFieldNamespace in interface FormRecordable

Returns:

the namespace

See Also:

FormRecordable.getFormFieldNamespace()

getFormFieldPath

public String getFormFieldPath()

Description copied from interface: FormRecordable

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

Specified by:

getFormFieldPath in interface FormRecordable

Returns:

the the form field path

See Also:

FormRecordable.getFormFieldPath()

setFormField

public void setFormField(String namespace,
                         String formFieldPath)

Description copied from interface: FormRecordable

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.

Specified by:

setFormField in interface FormRecordable

Parameters:

namespace - the namespace of the form field

formFieldPath - the path of the form field

See Also:

FormRecordable.setFormField(String,String)

getFormNamespaceAndPath

public String getFormNamespaceAndPath()

Returns:

Returns the formNamespaceAndPath.

setFormNamespaceAndPath

public void setFormNamespaceAndPath(String formNamespaceAndPath)

Setter method

Parameters:

formNamespaceAndPath -

getFormFieldNamespace

public static String getFormFieldNamespace(String formNamespaceAndPath)

getFormFieldPath

public static String getFormFieldPath(String formNamespaceAndPath)

getFormNamespaceAndPath

public static String getFormNamespaceAndPath(String namespace,
                                             String formFieldPath)