org.openmrs

Class FormResource

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.FormResource

All Implemented Interfaces:

Serializable, CustomValueDescriptor, SingleCustomValue<FormResource>, OpenmrsObject

public class FormResource
extends BaseOpenmrsObject
implements CustomValueDescriptor, SingleCustomValue<FormResource>

A FormResource is meant as a way for modules to add arbitrary information to a Form. FormResources are essentially just key-value pairs. The value is stored as a custom datatype. A Form can have 0-n FormResources but only one FormResource per name per Form. The name of a resource specifies one of many resources that can be stored for a particular owner. Only one resource for each name will ever be saved.

Since:

1.9

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FormResource()
FormResource(FormResource old) Create a copy of a provided FormResource, ignoring the uuid and id of the original

Method Summary

Modifier and Type	Method and Description
User	getChangedBy()
String	getDatatypeClassname() Return the name of a class that implements CustomDatatype.
String	getDatatypeConfig() May be null.
Date	getDateChanged()
FormResource	getDescriptor()
boolean	getDirty()
Form	getForm() gets the form
Integer	getFormResourceId() gets the form resource id
String	getHandlerConfig() May be null.
Integer	getId()
String	getName() gets the name of the resource
String	getPreferredHandlerClassname() May be null.
Object	getValue() Convenience method to get the typed version of the serializedValue.
String	getValueReference()
boolean	isDirty() Deprecated. as of 2.0, use getDirty()
void	setChangedBy(User changedBy)
void	setDatatypeClassname(String datatypeClassname)
void	setDatatypeConfig(String datatypeConfig)
void	setDateChanged(Date dateChanged)
void	setForm(Form form) sets the form
void	setFormResourceId(Integer formResourceId) sets the form resource id
void	setHandlerConfig(String handlerConfig)
void	setId(Integer id)
void	setName(String name) sets the name of the resource
void	setPreferredHandlerClassname(String preferredHandlerClassname)
<T> void	setValue(T typedValue) Sets the typed value.
void	setValueReferenceInternal(String valueToPersist) Directly set the String value that OpenMRS should persist in the database in a varchar column.

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

Constructor Detail

FormResource

public FormResource()

FormResource

public FormResource(FormResource old)

Create a copy of a provided FormResource, ignoring the uuid and id of the original

Parameters:

old - the original FormResource to be copied

Method Detail

getId

public Integer getId()

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

See Also:

OpenmrsObject.getId()

setId

public void setId(Integer id)

Specified by:

setId in interface OpenmrsObject

Parameters:

id - - The unique Identifier for the object

See Also:

OpenmrsObject.setId(java.lang.Integer)

getForm

public Form getForm()

gets the form

Returns:

the form

setForm

public void setForm(Form form)

sets the form

Parameters:

form - the form

getFormResourceId

public Integer getFormResourceId()

gets the form resource id

Returns:

the form resource's id

setFormResourceId

public void setFormResourceId(Integer formResourceId)

sets the form resource id

Parameters:

formResourceId - the form resource's id

getName

public String getName()

gets the name of the resource

Returns:

the name of the resource

setName

public void setName(String name)

sets the name of the resource

Parameters:

name - the name of the resource

getDatatypeClassname

public String getDatatypeClassname()

Description copied from interface: CustomValueDescriptor

Return the name of a class that implements CustomDatatype.

Specified by:

getDatatypeClassname in interface CustomValueDescriptor

Returns:

the datatype used to store this custom value

See Also:

CustomValueDescriptor.getDatatypeClassname()

setDatatypeClassname

public void setDatatypeClassname(String datatypeClassname)

Parameters:

datatypeClassname - the datatypeClassname to set

getDatatypeConfig

public String getDatatypeConfig()

Description copied from interface: CustomValueDescriptor

May be null.

Specified by:

getDatatypeConfig in interface CustomValueDescriptor

Returns:

the configuration to be passed to the datatype. For example if the datatype is RegexValidatedString the datatypeConfig would be the regular expression

See Also:

CustomValueDescriptor.getDatatypeConfig()

setDatatypeConfig

public void setDatatypeConfig(String datatypeConfig)

Parameters:

datatypeConfig - the datatypeConfig to set

getPreferredHandlerClassname

public String getPreferredHandlerClassname()

Description copied from interface: CustomValueDescriptor

May be null.

Specified by:

getPreferredHandlerClassname in interface CustomValueDescriptor

Returns:

the fully-qualified classname of the preferred CustomDatatypeHandler chosen by the system administrator for this attribute type.

See Also:

CustomValueDescriptor.getPreferredHandlerClassname()

setPreferredHandlerClassname

public void setPreferredHandlerClassname(String preferredHandlerClassname)

Parameters:

preferredHandlerClassname - the preferredHandlerClassname to set

getHandlerConfig

public String getHandlerConfig()

Description copied from interface: CustomValueDescriptor

May be null.

Specified by:

getHandlerConfig in interface CustomValueDescriptor

Returns:

the configuration to be passed to the handler for a datatype. For example if the datatype is "regex-validated-string", the handlerConfig would be the regular expression.

See Also:

CustomValueDescriptor.getHandlerConfig()

setHandlerConfig

public void setHandlerConfig(String handlerConfig)

Parameters:

handlerConfig - the handlerConfig to set

getDescriptor

public FormResource getDescriptor()

Specified by:

getDescriptor in interface SingleCustomValue<FormResource>

Returns:

metadata describing this custom value

See Also:

SingleCustomValue.getDescriptor()

getValueReference

public String getValueReference()

Specified by:

getValueReference in interface SingleCustomValue<FormResource>

Returns:

the value persisted in a database in a varchar column. Not necessarily human-readable.

See Also:

SingleCustomValue.getValueReference()

getValue

public Object getValue()

Description copied from interface: SingleCustomValue

Convenience method to get the typed version of the serializedValue. (This will result in a call to a CustomDatatype.fromReferenceString(String).)

Specified by:

getValue in interface SingleCustomValue<FormResource>

Returns:

typed value, converted from serializedValue by a CustomDatatype

See Also:

SingleCustomValue.getValue()

setValue

public <T> void setValue(T typedValue)

Description copied from interface: SingleCustomValue

Sets the typed value. (This will result in a call to CustomDatatype.getReferenceStringForValue(Object)

Specified by:

setValue in interface SingleCustomValue<FormResource>

See Also:

SingleCustomValue.setValue(java.lang.Object)

setValueReferenceInternal

public void setValueReferenceInternal(String valueToPersist)

Description copied from interface: SingleCustomValue

Directly set the String value that OpenMRS should persist in the database in a varchar column. Implementations should validate this value and throw an InvalidCustomValueException if it's invalid, rather than setting it blindly. If you are coding against the OpenMRS API, you should use SingleCustomValue.setValue(Object) instead.

Specified by:

setValueReferenceInternal in interface SingleCustomValue<FormResource>

See Also:

SingleCustomValue.setValueReferenceInternal(java.lang.String)

isDirty

@Deprecated
public boolean isDirty()

Deprecated. as of 2.0, use getDirty()

Specified by:

isDirty in interface SingleCustomValue<FormResource>

Returns:

whether or not setValue has been called (thus CustomDatatype.save(Object, String) needs to be called

See Also:

SingleCustomValue.isDirty()

getDirty

public boolean getDirty()

getChangedBy

public User getChangedBy()

Returns:

Returns the changedBy.

setChangedBy

public void setChangedBy(User changedBy)

Parameters:

changedBy - The user that changed this object

getDateChanged

public Date getDateChanged()

Returns:

Returns the date this object was changed

setDateChanged

public void setDateChanged(Date dateChanged)

Parameters:

dateChanged - The date this object was changed