Revision: 451
          http://svn.sourceforge.net/stripes/?rev=451&view=rev
Author:   tfenne
Date:     2006-10-25 04:36:26 -0700 (Wed, 25 Oct 2006)

Log Message:
-----------
Cleanup of javadoc on ValidationErrorHandler

Modified Paths:
--------------
    
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrorHandler.java

Modified: 
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrorHandler.java
===================================================================
--- 
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrorHandler.java
    2006-10-25 02:17:05 UTC (rev 450)
+++ 
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrorHandler.java
    2006-10-25 11:36:26 UTC (rev 451)
@@ -23,33 +23,35 @@
  * they came and the ActionBean instance is discarded.</p>
  *
  * <p>Implementing this interface gives ActionBeans the chance to modify what 
happens when the
- * binding phase generates errors. The handleValidationErrors method is 
invoked after binding, but
- * before any custom validation is invoked (if the ActionBean implements 
Validatable), and is
- * only invoked if there are errors. Also, note that setContext() will always 
have been
- * invoked prior to handleValidationErrors(), allowing the bean access to the 
event name
- * and other information.</p>
+ * binding and/or validation phase(s) generate errors. The 
handleValidationErrors method is
+ * invoked after all validation has completed - i.e. after annotation based 
validation and any
+ * [EMAIL PROTECTED] ValidationMethod}s that are applicable for the current 
request. Invocation only happens
+ * when one or more validation errors exist. Also, note that [EMAIL PROTECTED] 
setContext()} will always have
+ * been invoked prior to [EMAIL PROTECTED] 
#handleValidationErrors(ValidationErrors)}, allowing the bean
+ * access to the event name and other information.</p>
  *
- * <p>When the handleValidationErrors() method is invoked, the ActionBean may 
do one or more
- * of the following:</p>
+ * <p>When the [EMAIL PROTECTED] #handleValidationErrors(ValidationErrors)}  
method is invoked, the
+ * [EMAIL PROTECTED] net.sourceforge.stripes.action.ActionBean} may do one or 
more of the following:</p>
  *
  * <ul>
  *   <li>Modify it's own internal state, e.g. unwind changes made by complex 
setter methods</li>
  *   <li>Remove validation errors from the ValidationErrors object</li>
  *   <li>Add new validation errors to the ValidationErrors object</li>
  *   <li>Modify errors in the ValidationErrors object</li>
+ *   <li>Any other operation, e.g. rollback a transaction, log an audit 
message etc.</li>
  *   <li>(Optionally) Re-direct the flow of execution by returning a 
substitute Resolution</li>
  * </ul>
  *
  * <p>For example, if you want to override the validation service's results 
and continue
- * execution, you might invoke errors.clear() to remove all the errors.  Doing 
this makes it
+ * execution, you might invoke [EMAIL PROTECTED] errors.clear()} to remove all 
the errors.  Doing this makes it
  * as though the errors had never been generated!  Or perhaps for a specific 
ActionBean you'd
  * like to redirect to a different error page instead of the page the user 
came from, in that
- * case you can simple return a new ForwardResolution or RedirectResolution to 
change where the
- * user will be sent.</p>
+ * case you can simply return a new [EMAIL PROTECTED] 
net.sourceforge.stripes.action.ForwardResolution} or
+ * [EMAIL PROTECTED] net.sourceforge.stripes.action.RedirectResolution} to 
change where the user will be sent.</p>
  *
- * <p>Returning a Resolution from this method is stricly <b>optional</b>. If a 
Resolution is
- * returned it will be executed instead of the error resolution.  If null is 
returned then the
- * error resolution will be executed as normal.</p>
+ * <p>Returning a [EMAIL PROTECTED] Resolution} from this method is stricly 
<b>optional</b>. If a Resolution is
+ * returned it will be executed instead of the error resolution.  If null is 
returned (and one
+ * or more errors persist) then the error resolution will be executed as 
normal.</p>
  *
  * @author Tim Fennell
  */


This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.

-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
Stripes-development mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/stripes-development

Reply via email to