KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > forms > validation > WidgetValidator


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.forms.validation;
17
18 import org.apache.cocoon.forms.formmodel.Widget;
19
20 /**
21  * Validates a widget. Validation can mean lots of different things depending on the
22  * actual widget and validator type, e.g. :
23  * <li>
24  * <ul>on fields, a validator will validate the field's value,</ul>
25  * <ul>on repeaters, a validator can perform inter-row validation</ul>
26  * </li>
27  * <p>
28  * A validator returns a boolean result indicating if validation was successful or not.
29  * If not successful, the validator <code>must<code> set a {@link org.apache.cocoon.forms.validation.ValidationError}
30  * on the validated widget or one of its children.
31  * <p>
32  * <em>Note:</em> It is important (although it cannot be explicitely forbidden) that a validator
33  * does not consider widgets that are not the validated widgets itself or its children, as this
34  * may lead to inconsistencies in the form model because of the way form validation occurs (depth-first
35  * traversal of the widget tree).
36  *
37  * @author <a HREF="http://www.apache.org/~sylvain/">Sylvain Wallez</a>
38  * @version $Id: WidgetValidator.java 151179 2005-02-03 16:55:16Z tim $
39  */
40 public interface WidgetValidator {
41     
42     /**
43      * Validate a widget.
44      *
45      * @param widget the widget to validate
46      * @return <code>true</code> if validation was successful. If not, the validator must have set
47      * a {@link ValidationError} on the widget or one of its children.
48      */
49     boolean validate(Widget widget);
50 }
51
Popular Tags