01: /*
02: * Copyright 2002-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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:
17: package org.springframework.validation;
18:
19: import org.springframework.beans.PropertyAccessException;
20:
21: /**
22: * Strategy for processing <code>DataBinder</code>'s missing field errors,
23: * and for translating a <code>PropertyAccessException</code> to a
24: * <code>FieldError</code>.
25: *
26: * <p>The error processor is pluggable so you can treat errors differently
27: * if you want to. A default implementation is provided for typical needs.
28: *
29: * <p>Note: As of Spring 2.0, this interface operates on a given BindingResult,
30: * to be compatible with any binding strategy (bean property, direct field access, etc).
31: * It can still receive a BindException as argument (since a BindException implements
32: * the BindingResult interface as well) but no longer operates on it directly.
33: *
34: * @author Alef Arendsen
35: * @author Juergen Hoeller
36: * @since 1.2
37: * @see DataBinder#setBindingErrorProcessor
38: * @see DefaultBindingErrorProcessor
39: * @see BindingResult
40: * @see BindException
41: */
42: public interface BindingErrorProcessor {
43:
44: /**
45: * Apply the missing field error to the given BindException.
46: * <p>Usually, a field error is created for a missing required field.
47: * @param missingField the field that was missing during binding
48: * @param bindingResult the errors object to add the error(s) to.
49: * You can add more than just one error or maybe even ignore it.
50: * The <code>BindingResult</code> object features convenience utils such as
51: * a <code>resolveMessageCodes</code> method to resolve an error code.
52: * @see BeanPropertyBindingResult#addError
53: * @see BeanPropertyBindingResult#resolveMessageCodes
54: */
55: void processMissingFieldError(String missingField,
56: BindingResult bindingResult);
57:
58: /**
59: * Translate the given <code>PropertyAccessException</code> to an appropriate
60: * error registered on the given <code>Errors</code> instance.
61: * <p>Note that two error types are available: <code>FieldError</code> and
62: * <code>ObjectError</code>. Usually, field errors are created, but in certain
63: * situations one might want to create a global <code>ObjectError</code> instead.
64: * @param ex the <code>PropertyAccessException</code> to translate
65: * @param bindingResult the errors object to add the error(s) to.
66: * You can add more than just one error or maybe even ignore it.
67: * The <code>BindingResult</code> object features convenience utils such as
68: * a <code>resolveMessageCodes</code> method to resolve an error code.
69: * @see Errors
70: * @see FieldError
71: * @see ObjectError
72: * @see MessageCodesResolver
73: * @see BeanPropertyBindingResult#addError
74: * @see BeanPropertyBindingResult#resolveMessageCodes
75: */
76: void processPropertyAccessException(PropertyAccessException ex,
77: BindingResult bindingResult);
78:
79: }
|