001    /*
002     * Copyright 2002-2005 the original author or authors.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not
005     * use this file except in compliance with the License. You may obtain a copy of
006     * the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
012     * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
013     * License for the specific language governing permissions and limitations under
014     * the License.
015     */
016    package org.springframework.binding.form;
017    
018    import org.springframework.binding.validation.ValidationMessage;
019    
020    /**
021     * A class that can generate ValidationMessages for exception that occur during
022     * a form model's binding process.
023     *
024     * @author Oliver Hutchison
025     * @see org.springframework.binding.form.support.DefaultBindingErrorMessageProvider
026     */
027    public interface BindingErrorMessageProvider {
028    
029            /**
030             * Translates the provided exception details into a ValidationMessage that
031             * will be used to provide feedback to the end user. Generally these
032             * exceptions results from type conversion problems.
033             *
034             * @param formModel the formModel
035             * @param propertyName the propertyName
036             * @param valueBeingSet the value which triggered the exception
037             */
038            ValidationMessage getErrorMessage(FormModel formModel, String propertyName, Object valueBeingSet, Exception e);
039    
040    }