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.woody.validation; 17 18 import org.apache.cocoon.woody.FormContext; 19 import org.apache.cocoon.woody.formmodel.Widget; 20 21 /** 22 * Validates a widget. Validation can mean lots of different things depending on the 23 * actual widget and validator type, e.g. : 24 * <li> 25 * <ul>on fields, a validator will validate the field's value,</ul> 26 * <ul>on repeaters, a validator can perform inter-row validation</ul> 27 * </li> 28 * <p> 29 * A validator returns a boolean result indicating if validation was successful or not. 30 * If not successful, the validator <code>must<code> set a {@link org.apache.cocoon.woody.validation.ValidationError} 31 * on the validated widget or one of its children. 32 * <p> 33 * <em>Note:</em> It is important (although it cannot be explicitely forbidden) that a validator 34 * does not consider widgets that are not the validated widgets itself or its children, as this 35 * may lead to inconsistencies in the form model because of the way form validation occurs (depth-first 36 * traversal of the widget tree). 37 * 38 * @author <a HREF="http://www.apache.org/~sylvain/">Sylvain Wallez</a> 39 * @version CVS $Id: WidgetValidator.java 30932 2004-07-29 17:35:38Z vgritsenko $ 40 */ 41 public interface WidgetValidator { 42 43 /** 44 * Validate a widget. 45 * 46 * @param widget the widget to validate 47 * @param context the form context 48 * @return <code>true</code> if validation was successful. If not, the validator must have set 49 * a {@link ValidationError} on the widget or one of its children. 50 */ 51 boolean validate(Widget widget, FormContext context); 52 } 53