| java.lang.Object
 org.springframework.webflow.action.FormObjectAccessor
| FormObjectAccessor | | public class FormObjectAccessor (Code) | | Convenience helper that encapsulates logic on how to retrieve and expose form
objects and associated errors to and from a flow execution request context.
Note: The form object available under the well known attribute name
FormObjectAccessor.CURRENT_FORM_OBJECT_ATTRIBUTE will be the last ("current") form
object set in the request context. The same is true for the associated errors
object. This implies that special care should be taken when accessing the
form object using this alias if there are multiple form objects available in
the flow execution request context!
See Also: org.springframework.webflow.execution.RequestContext
See Also: org.springframework.validation.Errors
author:
Keith Donald
author:
Erwin Vervaet |
| Method Summary | |
| public Errors | getCurrentFormErrors()
Gets the form object Errors tracker from the context,
using the form object name
FormObjectAccessor.CURRENT_FORM_OBJECT_ATTRIBUTE . | | public Errors | getCurrentFormErrors(ScopeType scopeType)
Gets the form object Errors tracker from the context,
using the form object name
FormObjectAccessor.CURRENT_FORM_OBJECT_ATTRIBUTE . | | public static String | getCurrentFormErrorsName()
Returns the current form object errors attribute name. | | public Object | getCurrentFormObject()
Gets the form object from the context, using the well-known attribute
name
FormObjectAccessor.CURRENT_FORM_OBJECT_ATTRIBUTE . | | public Object | getCurrentFormObject(ScopeType scopeType)
Gets the form object from the context, using the well-known attribute
name
FormObjectAccessor.CURRENT_FORM_OBJECT_ATTRIBUTE . | | public static String | getCurrentFormObjectName()
Returns the current form object name. | | public Errors | getFormErrors(String formObjectName, ScopeType scopeType)
Gets the form object Errors tracker from the context,
using the specified form object name. | | public Object | getFormObject(String formObjectName, ScopeType scopeType)
Gets the form object from the context, using the specified name. | | public Object | getFormObject(String formObjectName, Class formObjectClass, ScopeType scopeType)
Gets the form object from the context, using the specified name. | | public void | putFormErrors(Errors errors, ScopeType scopeType)
Expose given errors instance in the specified scope. | | public void | putFormObject(Object formObject, String formObjectName, ScopeType scopeType)
Expose given form object using given name in specified scope. | | public void | setCurrentFormErrors(Errors errors, ScopeType scopeType)
Expose given errors instance using the well known alias
FormObjectAccessor.CURRENT_FORM_OBJECT_ATTRIBUTE in the specified scope. | | public void | setCurrentFormObject(Object formObject, ScopeType scopeType)
Expose given form object using the well known alias
FormObjectAccessor.CURRENT_FORM_OBJECT_ATTRIBUTE in the specified scope. |
| FormObjectAccessor | | public FormObjectAccessor(RequestContext context)(Code) | | Creates a form object accessor that wraps the given context.
Parameters:
context - the flow execution request context |
| getCurrentFormErrors | | public Errors getCurrentFormErrors()(Code) | | Gets the form object Errors tracker from the context,
using the form object name
FormObjectAccessor.CURRENT_FORM_OBJECT_ATTRIBUTE . This
method will search all scopes.
the form object Errors tracker, or null if not found |
| getCurrentFormErrors | | public Errors getCurrentFormErrors(ScopeType scopeType)(Code) | | Gets the form object Errors tracker from the context,
using the form object name
FormObjectAccessor.CURRENT_FORM_OBJECT_ATTRIBUTE .
Parameters:
scopeType - the scope to obtain the errors from the form object Errors tracker, or null if not found |
| getCurrentFormErrorsName | | public static String getCurrentFormErrorsName()(Code) | | Returns the current form object errors attribute name.
the current form object errors attribute name |
| getCurrentFormObjectName | | public static String getCurrentFormObjectName()(Code) | | Returns the current form object name.
the current form object name |
| getFormErrors | | public Errors getFormErrors(String formObjectName, ScopeType scopeType)(Code) | | Gets the form object Errors tracker from the context,
using the specified form object name.
Parameters:
formObjectName - the name of the Errors object, which will beprefixed with BindException.ERROR_KEY_PREFIX
Parameters:
scopeType - the scope to obtain the errors from the form object errors instance, or null if not found |
| getFormObject | | public Object getFormObject(String formObjectName, ScopeType scopeType)(Code) | | Gets the form object from the context, using the specified name.
Parameters:
formObjectName - the name of the form object in the context
Parameters:
scopeType - the scope to obtain the form object from the form object, or null if not found |
| getFormObject | | public Object getFormObject(String formObjectName, Class formObjectClass, ScopeType scopeType)(Code) | | Gets the form object from the context, using the specified name.
Parameters:
formObjectName - the name of the form in the context
Parameters:
formObjectClass - the class of the form object, which will beverified
Parameters:
scopeType - the scope to obtain the form object from the form object, or null if not found |
| putFormErrors | | public void putFormErrors(Errors errors, ScopeType scopeType)(Code) | | Expose given errors instance in the specified scope. Given errors
instance will become the current form errors instance.
Parameters:
errors - the errors object
Parameters:
scopeType - the scope to expose the errors in |
| putFormObject | | public void putFormObject(Object formObject, String formObjectName, ScopeType scopeType)(Code) | | Expose given form object using given name in specified scope. Given
object will become the current form object.
Parameters:
formObject - the form object
Parameters:
formObjectName - the name of the form object
Parameters:
scopeType - the scope in which to expose the form object |
| setCurrentFormErrors | | public void setCurrentFormErrors(Errors errors, ScopeType scopeType)(Code) | | Expose given errors instance using the well known alias
FormObjectAccessor.CURRENT_FORM_OBJECT_ATTRIBUTE in the specified scope.
Parameters:
errors - the errors instance
Parameters:
scopeType - the scope in which to expose the errors instance |
|
|