FormBase (JAFFA Project)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jaffa.presentation.portlet
Class FormBase

java.lang.Object
  org.apache.struts.action.ActionForm
      org.jaffa.presentation.portlet.FormBase

All Implemented Interfaces:: Serializable

Direct Known Subclasses:: ComponentDetailsForm, ComponentExplorerForm, FinderCriteriaForm, FinderForm, MaintForm, SessionExplorerForm

public class FormBase
extends ActionForm

This is the base class for all the 'Form' classes

See Also:: Serialized Form

Field Summary

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary
`FormBase()`

Method Summary
`void`	`cleanup()` The form should override this method for destroying any references that it holds
`void`	`clearErrors(HttpServletRequest request)` This clears all the errors generated while processing this Form
`Component`	`getComponent()` Returns the Component to which this Form belongs
`ActionErrors`	`getErrors(HttpServletRequest request)` Returns the errors generated while processing this Form
`WidgetCache`	`getWidgetCache()` Returns the WidgetCache of all the models for the Component
`boolean`	`hasErrors(HttpServletRequest request)` Checks if any errors have been generated
`void`	`initForm()` The form should override this method for defaulting the data in the form-bean
`void`	`raiseError(HttpServletRequest request, String property, ActionError error)` Record an error
`void`	`raiseError(HttpServletRequest request, String property, ApplicationException appExp)` Record an error.
`void`	`raiseError(HttpServletRequest request, String property, ApplicationExceptions appExps)` Record an error.
`void`	`raiseError(HttpServletRequest request, String property, String key)` Record an error.
`void`	`raiseError(HttpServletRequest request, String property, String key, Object value0)` Record an error.
`void`	`raiseError(HttpServletRequest request, String property, String key, Object[] values)` Record an error.
`void`	`raiseError(HttpServletRequest request, String property, String key, Object value0, Object value1)` Record an error.
`void`	`raiseError(HttpServletRequest request, String property, String key, Object value0, Object value1, Object value2)` Record an error.
`void`	`raiseError(HttpServletRequest request, String property, String key, Object value0, Object value1, Object value2, Object value3)` Record an error.
`void`	`reset(ActionMapping mapping, HttpServletRequest request)` This sets the Component & the WidgetCache fields
`void`	`setComponent(Component component)` Sets the Component for the Form

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

FormBase

public FormBase()

Method Detail

getComponent

public Component getComponent()

Returns the Component to which this Form belongs

Returns:: The Component for this Form

setComponent

public void setComponent(Component component)

Sets the Component for the Form

Parameters:: component - The Component object

getWidgetCache

public WidgetCache getWidgetCache()

Returns the WidgetCache of all the models for the Component

Returns:: The WidgetCache object

initForm

public void initForm()

The form should override this method for defaulting the data in the form-bean

cleanup

public void cleanup()

The form should override this method for destroying any references that it holds

reset

public void reset(ActionMapping mapping,
                  HttpServletRequest request)

This sets the Component & the WidgetCache fields

Parameters:: mapping - The mapping used to select this instance; request - The servlet request we are processing

clearErrors

public void clearErrors(HttpServletRequest request)

This clears all the errors generated while processing this Form

Parameters:: request - The servlet request we are processing

getErrors

public ActionErrors getErrors(HttpServletRequest request)

Returns the errors generated while processing this Form

Parameters:: request - The servlet request we are processing
Returns:: If no errors are found, return null or an ActionErrors object with recorded error messages

hasErrors

public boolean hasErrors(HttpServletRequest request)

Checks if any errors have been generated

Parameters:: request - The servlet request we are processing
Returns:: true if errors exist

raiseError

public void raiseError(HttpServletRequest request,
                       String property,
                       ActionError error)

Record an error

Parameters:: request - The servlet request we are processing; property - Property name (or ActionErrors.GLOBAL_ERROR); error - The error message to be added

raiseError

public void raiseError(HttpServletRequest request,
                       String property,
                       String key)

Record an error. This implicitly creates an ActionError for the input key

Parameters:: request - The servlet request we are processing; property - Property name (or ActionErrors.GLOBAL_ERROR); key - Message key for this error message