    001    // Copyright 2007, 2008 The Apache Software Foundation
    002    //
    003    // Licensed under the Apache License, Version 2.0 (the "License");
    004    // you may not use this file except in compliance with the License.
    005    // You may obtain a copy of the License at
    006    //
    007    //     http://www.apache.org/licenses/LICENSE-2.0
    008    //
    009    // Unless required by applicable law or agreed to in writing, software
    010    // distributed under the License is distributed on an "AS IS" BASIS,
    011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    012    // See the License for the specific language governing permissions and
    013    // limitations under the License.
    014
    015    package org.apache.tapestry5;
    016
    017    /**
    018     * Allows control over validation concerns of a Form component.
    019     */
    020    public interface FormValidationControl
    021    {
    022        /**
    023         * A convienience for invoking {@link org.apache.tapestry5.ValidationTracker#recordError(String)}.
    024         */
    025        void recordError(String errorMessage);
    026
    027        /**
    028         * A convienience for invoking {@link org.apache.tapestry5.ValidationTracker#recordError(Field, String)}.
    029         */
    030        void recordError(Field field, String errorMessage);
    031
    032        /**
    033         * Returns true if the form's {@link ValidationTracker} contains any {@link org.apache.tapestry5.ValidationTracker#getHasErrors()
    034         * errors}.
    035         */
    036        boolean getHasErrors();
    037
    038        /**
    039         * Returns true if the form's {@link org.apache.tapestry5.ValidationTracker} does not contain any {@link
    040         * org.apache.tapestry5.ValidationTracker#getHasErrors() errors}.
    041         */
    042        boolean isValid();
    043
    044        /**
    045         * Invokes {@link org.apache.tapestry5.ValidationTracker#clear()}.
    046         */
    047        void clearErrors();
    048    }