com.arsdigita.bebop.event
Interface FormValidationListener

All Superinterfaces:
EventListener
All Known Implementing Classes:
ChangePasswordForm, UserForm, UserNewForm, UserRegistrationForm

public interface FormValidationListener
extends EventListener

Defines the interface for a class that implements a validation check on a set of form data.

Version:
$Id: //core-platform/dev/src/com/arsdigita/bebop/event/FormValidationListener.java#8 $
Author:
Karl Goldstein, Uday Mathur

Field Summary
static String versionId
           
 
Method Summary
 void validate(FormSectionEvent e)
          Performs a validation check on the specified FormData object, involving any number of parameters.
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Method Detail

validate

public void validate(FormSectionEvent e)
              throws FormProcessException
Performs a validation check on the specified FormData object, involving any number of parameters.

The check is always performed after all HTTP request parameters have been converted to data objects and stored in the FormData object.

If a validation error is encountered, the setError method of the FormData object may be used to set an error message for reporting back to the user.

This method is responsible for catching any exceptions that may occur during the validation. These exceptions may either be handled internally, or if they are unrecoverable may be rethrown as instances of FormProcessException.

Throws:
FormProcessException - If the data does not pass the check.


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC