FormResource (OpenMRS 1.10.7-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.FormResource

All Implemented Interfaces:

java.io.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

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDatatypeClassname()` Return the name of a class that implements `CustomDatatype`.
`java.lang.String`	`getDatatypeConfig()` May be null.
`FormResource`	`getDescriptor()` The metadata describing this custom value
`Form`	`getForm()` gets the form
`java.lang.Integer`	`getFormResourceId()` gets the form resource id
`java.lang.String`	`getHandlerConfig()` May be null.
`java.lang.Integer`	`getId()`
`java.lang.String`	`getName()` gets the name of the resource
`java.lang.String`	`getPreferredHandlerClassname()` May be null.
`java.lang.Object`	`getValue()` Convenience method to get the typed version of the serializedValue.
`java.lang.String`	`getValueReference()`
`boolean`	`isDirty()`
`void`	`setDatatypeClassname(java.lang.String datatypeClassname)`
`void`	`setDatatypeConfig(java.lang.String datatypeConfig)`
`void`	`setForm(Form form)` sets the form
`void`	`setFormResourceId(java.lang.Integer formResourceId)` sets the form resource id
`void`	`setHandlerConfig(java.lang.String handlerConfig)`
`void`	`setId(java.lang.Integer id)`
`void`	`setName(java.lang.String name)` sets the name of the resource
`void`	`setPreferredHandlerClassname(java.lang.String preferredHandlerClassname)`
`<T> void`	`setValue(T typedValue)` Sets the typed value.
`void`	`setValueReferenceInternal(java.lang.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 java.lang.Integer getId()
```
    Specified by:
    
    getId in interface OpenmrsObject
    
    Returns:
    
    id - The unique Identifier for the object
    
    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
    
    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 java.lang.Integer getFormResourceId()
```
    gets the form resource id
    
    Returns:
    
    the form resource's id
  - setFormResourceId
```
public void setFormResourceId(java.lang.Integer formResourceId)
```
    sets the form resource id
    
    Parameters:
    
    formResourceId - the form resource's id
  - getName
```
public java.lang.String getName()
```
    gets the name of the resource
    
    Returns:
    
    the name of the resource
  - setName
```
public void setName(java.lang.String name)
```
    sets the name of the resource
    
    Parameters:
    
    name - the name of the resource
  - getDatatypeClassname
```
public java.lang.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(java.lang.String datatypeClassname)
```
    Parameters:
    
    datatypeClassname - the datatypeClassname to set
  - getDatatypeConfig
```
public java.lang.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(java.lang.String datatypeConfig)
```
    Parameters:
    
    datatypeConfig - the datatypeConfig to set
  - getPreferredHandlerClassname
```
public java.lang.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(java.lang.String preferredHandlerClassname)
```
    Parameters:
    
    preferredHandlerClassname - the preferredHandlerClassname to set
  - getHandlerConfig
```
public java.lang.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(java.lang.String handlerConfig)
```
    Parameters:
    
    handlerConfig - the handlerConfig to set
  - getDescriptor
```
public FormResource getDescriptor()
```
    Description copied from interface: SingleCustomValue
    
    The metadata describing this custom value
    
    Specified by:
    
    getDescriptor in interface SingleCustomValue<FormResource>
    
    Returns:
    
    See Also:
    
    SingleCustomValue.getDescriptor()
  - getValueReference
```
public java.lang.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 java.lang.Object getValue()
                          throws InvalidCustomValueException
```
    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
    
    Throws:
    
    InvalidCustomValueException
    
    See Also:
    
    SingleCustomValue.getValue()
  - setValue
```
public <T> void setValue(T typedValue)
                  throws InvalidCustomValueException
```
    Description copied from interface: SingleCustomValue
    
    Sets the typed value. (This will result in a call to CustomDatatype#toReferenceString(Object)
    
    Specified by:
    
    setValue in interface SingleCustomValue<FormResource>
    
    Throws:
    
    InvalidCustomValueException
    
    See Also:
    
    SingleCustomValue.setValue(java.lang.Object)
  - setValueReferenceInternal
```
public void setValueReferenceInternal(java.lang.String valueToPersist)
                               throws InvalidCustomValueException
```
    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>
    
    Throws:
    
    InvalidCustomValueException
    
    See Also:
    
    SingleCustomValue.setValueReferenceInternal(java.lang.String)
  - isDirty
```
public boolean isDirty()
```
    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()

Class FormResource

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Constructor Detail

FormResource

FormResource

Method Detail

getId

setId

getForm

setForm

getFormResourceId

setFormResourceId

getName

setName

getDatatypeClassname

setDatatypeClassname

getDatatypeConfig

setDatatypeConfig

getPreferredHandlerClassname

setPreferredHandlerClassname

getHandlerConfig

setHandlerConfig

getDescriptor

getValueReference

getValue

setValue

setValueReferenceInternal

isDirty