org.openmrs.web.attribute.handler

Interface WebDatatypeHandler<DT extends CustomDatatype<T>,T>

All Superinterfaces:

CustomDatatypeHandler<CustomDatatype<T>,T>, HtmlDisplayableDatatypeHandler<T>

All Known Implementing Classes:

LongFreeTextFileUploadHandler, LongFreeTextTextareaHandler

public interface WebDatatypeHandler<DT extends CustomDatatype<T>,T>
extends HtmlDisplayableDatatypeHandler<T>

A web-layer extension of CustomDatatypeHandler, which generates the HTML for a widget, and handles the submission of that widget

Method Summary

Modifier and Type	Method and Description
T	getValue(DT datatype, javax.servlet.http.HttpServletRequest request, java.lang.String formFieldName) Handles a form submission including a widget generated by this handler
java.lang.String	getWidgetHtml(DT datatype, java.lang.String formFieldName, java.lang.String widgetId, T startingValue) Generates the HTML for a widget

Methods inherited from interface org.openmrs.web.attribute.handler.HtmlDisplayableDatatypeHandler

toHtml, toHtmlSummary

Methods inherited from interface org.openmrs.customdatatype.CustomDatatypeHandler

setHandlerConfiguration

Method Detail

getWidgetHtml

java.lang.String getWidgetHtml(DT datatype,
                               java.lang.String formFieldName,
                               java.lang.String widgetId,
                               T startingValue)

Generates the HTML for a widget

Parameters:

datatype - the underlying datatype for this widget

formFieldName - the name the widget should submit with

widgetId - a unique id, generated by the web framework, that the widget should use

startingValue - the initial value for the generated HTML

Returns:

HTML for editing/creating a value of this datatype

getValue

T getValue(DT datatype,
           javax.servlet.http.HttpServletRequest request,
           java.lang.String formFieldName)
    throws InvalidCustomValueException

Handles a form submission including a widget generated by this handler

Parameters:

datatype - the underlying datatype for this widget

request - the submitted HTTP request

formFieldName - the same value passed to getWidgetHtml(CustomDatatype, String, String, Object) when generating this widget

Returns:

a parsed and validated value submitted by the widget

Throws:

InvalidCustomValueException