1 /*
2 * $Id: FieldValidator.java,v 1.4 2004/04/07 10:43:24 eelco12 Exp $
3 * $Revision: 1.4 $
4 * $Date: 2004/04/07 10:43:24 $
5 *
6 * ====================================================================
7 * Copyright (c) 2003, Open Edge B.V.
8 * All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 * Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer. Redistributions
13 * in binary form must reproduce the above copyright notice, this list of
14 * conditions and the following disclaimer in the documentation and/or other
15 * materials provided with the distribution. Neither the name of OpenEdge B.V.
16 * nor the names of its contributors may be used to endorse or promote products
17 * derived from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29 * THE POSSIBILITY OF SUCH DAMAGE.
30 */
31 package nl.openedge.baritus.validation;
32
33 import nl.openedge.baritus.FormBeanContext;
34
35 import org.infohazard.maverick.flow.ControllerContext;
36
37 /***
38 * Use this for custom validation
39 * @author Eelco Hillenius
40 */
41 public interface FieldValidator
42 {
43 /***
44 * Checks if value is valid.
45 * This method should return true if validation succeeded or false otherwise.
46 * For error handling you have two options:
47 * <ul>
48 * <li>
49 * Use the callback method getErrorMessage. You should use this if the error
50 * message is allways the same (except for maybe some parameters in the message).
51 * </li>
52 * <li>
53 * For more flexibility, like if you have more stages of validation that each generates
54 * its own message(s), you can register errors directly with the formBeanContext
55 * </li>
56 * </ul>
57 * @param cctx maverick context
58 * @param formBeanContext context with bean for this currentRequest
59 * @param fieldName field name of parameter
60 * @param value the value of this parameter
61 * @return true if valid, false if not.
62 */
63 public boolean isValid(
64 ControllerContext cctx,
65 FormBeanContext formBeanContext,
66 String fieldName,
67 Object value);
68
69 /***
70 * if value is not valid, get the custom value to set as the field override
71 * in the form.
72 * @param value the original input value
73 * @return the value that should be used as override value
74 */
75 public Object getOverrideValue(Object value);
76
77 }