jbpm-form-modeler-api 6.2.0.Beta3

org.jbpm.formModeler.core.processing
Interface FieldHandler


public interface FieldHandler


Method Summary
 String[] getCompatibleClassNames()
          Determine the list of class names this field can generate.
 String getPageToIncludeForDisplaying()
          When rendering a form, if field is handled by this handler, determine the page that renders the displaying of the value
 String getPageToIncludeForRendering()
          When rendering a form, if field is handled by this handler, determine the page that renders the input(s)
 Map getParamValue(Field field, String inputName, Object objectValue)
          Determine the value as a parameter map for a given input value.
 Object getValue(Field field, String inputName, Map parametersMap, Map filesMap, String desiredClassName, Object previousValue)
          Read a parameter value (normally from a request), and translate it to an object with desired class (that must be one of the returned by this handler)
 boolean isEmpty(Object value)
          Determine if supplied value is empty
 

Method Detail

getCompatibleClassNames

String[] getCompatibleClassNames()
Determine the list of class names this field can generate. That is, normally, a field can generate multiple outputs (an input text can generate Strings, Integers, ...)

Returns:
the set of class types that can be generated by this handler.

getValue

Object getValue(Field field,
                String inputName,
                Map parametersMap,
                Map filesMap,
                String desiredClassName,
                Object previousValue)
                throws Exception
Read a parameter value (normally from a request), and translate it to an object with desired class (that must be one of the returned by this handler)

Returns:
a object with desired class
Throws:
Exception

getParamValue

Map getParamValue(Field field,
                  String inputName,
                  Object objectValue)
Determine the value as a parameter map for a given input value. This is like the inverse operation of getValue()

Parameters:
objectValue - Object value to represent
field - field definition
Returns:
a Map representing the parameter values expected inside a request that would cause the form to generate given object value as a result.

getPageToIncludeForRendering

String getPageToIncludeForRendering()
When rendering a form, if field is handled by this handler, determine the page that renders the input(s)

Returns:
a page to include

getPageToIncludeForDisplaying

String getPageToIncludeForDisplaying()
When rendering a form, if field is handled by this handler, determine the page that renders the displaying of the value

Returns:
a page to include

isEmpty

boolean isEmpty(Object value)
Determine if supplied value is empty

Parameters:
value -
Returns:
true if value can be considered empty

jbpm-form-modeler-api 6.2.0.Beta3

Copyright © 2001-2014 JBoss by Red Hat. All Rights Reserved.