org.openmrs.customdatatype

Interface CustomValueDescriptor

All Known Subinterfaces:

AttributeType<OwningType>, RepeatingCustomValueDescriptor

All Known Implementing Classes:

BaseAttributeType, ConceptAttributeType, DiagnosisAttributeType, FormResource, GlobalProperty, LocationAttributeType, OrderAttributeType, OrderGroupAttributeType, OrderSetAttributeType, ProgramAttributeType, ProviderAttributeType, VisitAttributeType

public interface CustomValueDescriptor

A metadata item describing how a type of custom value is stored. (For example a GlobalProperty is its own CustomValueDescriptor, and a VisitAttributeTypes is the descriptor for VisitAttribute.)

Since:

1.9

Method Summary

Modifier and Type	Method and Description
String	getDatatypeClassname() Return the name of a class that implements CustomDatatype.
String	getDatatypeConfig() May be null.
String	getHandlerConfig() May be null.
String	getPreferredHandlerClassname() May be null.

Method Detail

getDatatypeClassname

String getDatatypeClassname()

Return the name of a class that implements CustomDatatype.

Returns:

the datatype used to store this custom value

See Also:

CustomDatatype

getDatatypeConfig

String getDatatypeConfig()

May be null.

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:

CustomDatatype.setConfiguration(String)

getPreferredHandlerClassname

String getPreferredHandlerClassname()

May be null.

Returns:

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

getHandlerConfig

String getHandlerConfig()

May be null.

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:

CustomDatatypeHandler.setHandlerConfiguration(String)