|
jbpm-form-modeler-api 6.2.0.Beta1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FormProcessor
A FormProcessor is a class that handles a form submission.
Field Summary | |
---|---|
static String |
ATTR_INTERPRETER
|
static String |
CUSTOM_NAMESPACE_SEPARATOR
|
static String |
DEFAULT_NAMESPACE
|
static String |
FORM_MODE
|
static String |
MODIFIED_FIELD_NAMES
|
static String |
NAMESPACE_SEPARATOR
|
Method Summary | |
---|---|
void |
clear(FormRenderContext context)
Clears status data for given render context |
void |
clear(Form form,
String namespace)
Clears status data for given form. |
void |
clear(String ctxUID)
Clears status data for given render context |
void |
clearField(Form form,
String namespace,
String fieldName)
Clear a field value. |
void |
clearFieldErrors(Form form,
String namespace)
Remove field errors that might be in this formStatus. |
void |
forceWrongField(Form form,
String namespace,
String fieldName)
Mark a field as wrong |
Object |
getAttribute(Form form,
String namespace,
String attributeName)
Gets an attribute for given form status |
Map |
getMapRepresentationToPersist(Form form,
String namespace)
Returns the Map to persis based on the data stored on the data stored on a FormStatus |
void |
modify(Form form,
String namespace,
String fieldName,
Object value)
Directly modify the status value for a form field. |
void |
persist(FormRenderContext context)
Persists the status for given FormRenderContext. |
void |
persist(String ctxUid)
Persists the status for given FormRenderContext id. |
Object |
persistFormHolder(Form form,
String namespace,
Map<String,Object> mapToPersist,
DataHolder holder,
Object loadedObject)
Persists the form fields that match the given holder |
FormStatusData |
read(Form form,
String namespace)
Read status for given form id. |
FormStatusData |
read(Form form,
String namespace,
Map<String,Object> formValues)
Read status for given form id. |
FormStatusData |
read(Form form,
String namespace,
Map<String,Object> formValues,
Map<String,Object> loadedObjects)
Read status for given form id. |
FormStatusData |
read(String ctxUid)
Read status for given FormRenderContext id. |
Map |
readValuesToLoad(Form form,
Map inputData,
Map outputData,
Map loadedObjects,
String namespace)
|
void |
setAttribute(Form form,
String namespace,
String attributeName,
Object attributeValue)
Sets an attribute for given form status |
void |
setFieldValue(Field field,
String namespace,
Map parametersMap,
Map filesMap,
boolean incremental)
|
void |
setValues(Form form,
String namespace,
Map parameterMap,
Map filesMap)
Get submit values from a request parameter map and a files map, and store it in a form status. |
void |
setValues(Form form,
String namespace,
Map parameterMap,
Map filesMap,
boolean incremental)
Get submit values from a request parameter map and a files map, and store it in a form status. |
Field Detail |
---|
static final String NAMESPACE_SEPARATOR
static final String CUSTOM_NAMESPACE_SEPARATOR
static final String DEFAULT_NAMESPACE
static final String MODIFIED_FIELD_NAMES
static final String FORM_MODE
static final String ATTR_INTERPRETER
Method Detail |
---|
void setValues(Form form, String namespace, Map parameterMap, Map filesMap)
form
- Form to processparameterMap
- Parameters map, as extracted from a request.filesMap
- files map, where a parameter name points to a filenamespace
- Form namespacevoid setValues(Form form, String namespace, Map parameterMap, Map filesMap, boolean incremental)
form
- Form to processparameterMap
- Parameters map, as extracted from a request.filesMap
- files map, where a parameter name points to a fileincremental
- Determines if form status should be cleared before setting the parameter valuesnamespace
- Form namespacevoid modify(Form form, String namespace, String fieldName, Object value)
form
- Form to modifynamespace
- Form namespacefieldName
- Field name to modifyvalue
- new value to set for this field.void setAttribute(Form form, String namespace, String attributeName, Object attributeValue)
form
- Form to processnamespace
- Form namespaceattributeName
- Attribute nameattributeValue
- Attribute valueObject getAttribute(Form form, String namespace, String attributeName)
form
- Form to processnamespace
- Form namespaceattributeName
- Attribute name
FormStatusData read(String ctxUid)
ctxUid
- Form render context UID
void persist(FormRenderContext context) throws Exception
context
- Form render context
Exception
Object persistFormHolder(Form form, String namespace, Map<String,Object> mapToPersist, DataHolder holder, Object loadedObject) throws Exception
form
- namespace
- mapToPersist
- holder
-
Exception
void persist(String ctxUid) throws Exception
ctxUid
- Form render context UID
Exception
FormStatusData read(Form form, String namespace)
form
- Form id to readnamespace
- Form namespace
FormStatusData read(Form form, String namespace, Map<String,Object> formValues)
form
- Form to readnamespace
- Form namespaceformValues
- Values to load into the status
FormStatusData read(Form form, String namespace, Map<String,Object> formValues, Map<String,Object> loadedObjects)
form
- Form to readnamespace
- Form namespaceformValues
- Values to load into the statusloadedObjects
- Map containing the objects loaded on the form
Map getMapRepresentationToPersist(Form form, String namespace) throws Exception
form
- The form that corresponds the FormStatusnamespace
- The namespace that identifies the FormStatus
Exception
- in case of error building the Mapvoid clear(FormRenderContext context)
context
- Context to clearvoid clear(String ctxUID)
ctxUID
- Render context id to clearvoid clear(Form form, String namespace)
form
- Form to clearnamespace
- Form namespacevoid clearField(Form form, String namespace, String fieldName)
form
- Form to processnamespace
- Form namespacefieldName
- Field name to clearvoid clearFieldErrors(Form form, String namespace)
form
- Form to clearnamespace
- Namespace to clearvoid forceWrongField(Form form, String namespace, String fieldName)
form
- form to modifynamespace
- namespacefieldName
- field name to mark as wrongMap readValuesToLoad(Form form, Map inputData, Map outputData, Map loadedObjects, String namespace)
void setFieldValue(Field field, String namespace, Map parametersMap, Map filesMap, boolean incremental)
|
jbpm-form-modeler-api 6.2.0.Beta1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |