org.openmrs.customdatatype

Interface SingleCustomValue<D extends CustomValueDescriptor>

Type Parameters:

D - the descriptor for this value, e.g. VisitAttribute implements SingleCustomValue

All Known Subinterfaces:

Attribute<AT,OT>

All Known Implementing Classes:

BaseAttribute, FormResource, GlobalProperty, LocationAttribute, ProviderAttribute, VisitAttribute

public interface SingleCustomValue<D extends CustomValueDescriptor>

Either a one-off custom value (e.g. a GlobalProperty) or a single custom value within a Customizable object that may hold multiple (e.g. a VisitAttribute within a Visit). The "referenceString" property is a String suitable for persistance in a database varchar column. It is typically a reference to the real value (e.g. it is the UUID of a location or the URI of an image in a PACS). The "objectValue" property accessors are convenience methods that use a CustomDatatype to convert to/from the String serializedValue.

Since:

1.9

See Also:

CustomDatatype}

Method Summary

Modifier and Type	Method and Description
D	getDescriptor() The metadata describing this custom value
java.lang.Object	getValue() Convenience method to get the typed version of the serializedValue.
java.lang.String	getValueReference()
boolean	isDirty()
<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.

Method Detail

getDescriptor

D getDescriptor()

The metadata describing this custom value

Returns:

getValueReference

java.lang.String getValueReference()
                            throws NotYetPersistedException

Returns:

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

Throws:

NotYetPersistedException - if valueReference hasn't been set by the CustomDatatype yet

setValueReferenceInternal

void setValueReferenceInternal(java.lang.String valueToPersist)
                        throws InvalidCustomValueException

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 setValue(Object) instead.

Parameters:

valueToPersist -

Throws:

InvalidCustomValueException

getValue

java.lang.Object getValue()
                   throws InvalidCustomValueException

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

Returns:

typed value, converted from serializedValue by a CustomDatatype

Throws:

InvalidCustomValueException

setValue

<T> void setValue(T typedValue)
           throws InvalidCustomValueException

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

Parameters:

typedValue -

Throws:

InvalidCustomValueException

isDirty

boolean isDirty()

Returns:

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