01: /*
02: * Copyright 2002-2005 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.core;
18:
19: /**
20: * Interface that can be implemented by exceptions etc that are error coded.
21: * The error code is a String, rather than a number, so it can be given
22: * user-readable values, such as "object.failureDescription".
23: *
24: * <p>An error code can be resolved by a MessageSource, for example.
25: *
26: * @author Rod Johnson
27: * @see org.springframework.context.MessageSource
28: */
29: public interface ErrorCoded {
30:
31: /**
32: * Return the error code associated with this failure.
33: * The GUI can render this any way it pleases, allowing for localization etc.
34: * @return a String error code associated with this failure,
35: * or <code>null</code> if not error-coded
36: */
37: String getErrorCode();
38:
39: }
|