ValidationFailure


1   /*****************************************************************
2    *   Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   ****************************************************************/
19  
20  package org.apache.cayenne.validation;
21  
22  import java.io.Serializable  ;
23  
24  /**
25   * Definea a single failure during the validation process. Implementing classes may
26   * store any extra information to help callers to identify the source and reasons 
27   * for the failure.
28   *
29   * @see BeanValidationFailure
30   * @author Fabricio Voznika
31   * @since 1.1
32   */
33  public interface ValidationFailure extends Serializable   {
34  
35      /**
36       * Returns the object that has generated the failure. For example, if a <code>Person</code>
37       * must have a name and a <code>ValidationFailure</code> is created when the
38       * user attempts to save it, the <code>Person</code> object would be the failure source.
39       *
40       * @return the failure's source or null in case a source cannot be defined.
41       */
42      public Object   getSource();
43  
44      /**
45       * Returns an user defined error object.
46       */
47      public Object   getError();
48  
49      /**
50       * Returns a String representation of the error object.
51       * This is used in log messages and exceptions.
52       */
53      public String   getDescription();
54  
55  }
56
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags