org.jbpm.formModeler.core.processing.fieldHandlers
Class LinkFieldHandler

java.lang.Object
  org.jbpm.formModeler.service.bb.commons.config.componentsFactory.BasicFactoryElement
      org.jbpm.formModeler.core.processing.AbstractFieldHandler
          org.jbpm.formModeler.core.processing.DefaultFieldHandler
              org.jbpm.formModeler.core.processing.fieldHandlers.LinkFieldHandler

All Implemented Interfaces:

Serializable, org.jbpm.formModeler.api.processing.FieldHandler, org.jbpm.formModeler.service.bb.commons.config.componentsFactory.FactoryLifecycle

public class LinkFieldHandler
extends DefaultFieldHandler

See Also:

Serialized Form

Constructor Summary

LinkFieldHandler()

Method Summary

boolean	acceptsPropertyName(String propName)
String[]	getCompatibleClassNames() Determine the list of class types this field can generate.
String	getName()
String	getPageToIncludeForDisplaying() When rendering a formulary, if field is handled by this handler, determine the page that renders the displaying of the value
String	getPageToIncludeForRendering() When rendering a formulary, if field is handled by this handler, determine the page that renders the input(s)
String	getPageToIncludeForSearching()
Map	getParamValue(String inputName, Object objectValue, String pattern) Determine the value as a parameter map for a given input value.
Object	getValue(org.jbpm.formModeler.api.model.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)
void	setPageToIncludeForDisplaying(String pageToIncludeForDisplaying)
void	setPageToIncludeForRendering(String pageToIncludeForRendering)
void	setPageToIncludeForSearching(String pageToIncludeForSearching)

Methods inherited from class org.jbpm.formModeler.core.processing.DefaultFieldHandler

getFunctionsProvider, getReplacementManager, setFunctionsProvider, setReplacementManager

Methods inherited from class org.jbpm.formModeler.core.processing.AbstractFieldHandler

checkBooleanParameter, getHumanName, initialize, isEvaluable

Methods inherited from class org.jbpm.formModeler.service.bb.commons.config.componentsFactory.BasicFactoryElement

addPeriodicTask, addPeriodicTask, factoryLookup, getComponentAlias, getComponentDescription, getComponentName, getComponentScope, init, setComponentAlias, shutdown, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinkFieldHandler

public LinkFieldHandler()

Method Detail

getName

public String getName()

Specified by:

getName in interface org.jbpm.formModeler.api.processing.FieldHandler

Overrides:

getName in class DefaultFieldHandler

getCompatibleClassNames

public String[] getCompatibleClassNames()

Determine the list of class types 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

public Object getValue(org.jbpm.formModeler.api.model.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

public Map getParamValue(String inputName,
                         Object objectValue,
                         String pattern)

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

pattern - Pattern to apply if any

Returns:

a Map representing the parameter values expected inside a request that would cause the form to generate given object value as a result.

getPageToIncludeForDisplaying

public String getPageToIncludeForDisplaying()

When rendering a formulary, if field is handled by this handler, determine the page that renders the displaying of the value

Returns:

a page to include

isEmpty

public boolean isEmpty(Object value)

setPageToIncludeForDisplaying

public void setPageToIncludeForDisplaying(String pageToIncludeForDisplaying)

acceptsPropertyName

public boolean acceptsPropertyName(String propName)

getPageToIncludeForRendering

public String getPageToIncludeForRendering()

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

Returns:

a page to include

setPageToIncludeForRendering

public void setPageToIncludeForRendering(String pageToIncludeForRendering)

getPageToIncludeForSearching

public String getPageToIncludeForSearching()

setPageToIncludeForSearching

public void setPageToIncludeForSearching(String pageToIncludeForSearching)