View Javadoc

1   /**
2   The contents of this file are subject to the Mozilla Public License Version 1.1 
3   (the "License"); you may not use this file except in compliance with the License. 
4   You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
5   Software distributed under the License is distributed on an "AS IS" basis, 
6   WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
7   specific language governing rights and limitations under the License. 
8   
9   The Original Code is "ValidationExceptionHandler.java".  Description: 
10  "Interface for handling violations during the validation process." 
11  
12  The Initial Developer of the Original Code is University Health Network. Copyright (C) 
13  2012.  All Rights Reserved. 
14  
15  Contributor(s): ______________________________________. 
16  
17  Alternatively, the contents of this file may be used under the terms of the 
18  GNU General Public License (the "GPL"), in which case the provisions of the GPL are 
19  applicable instead of those above.  If you wish to allow use of your version of this 
20  file only under the terms of the GPL and not to allow others to use your version 
21  of this file under the MPL, indicate your decision by deleting  the provisions above 
22  and replace  them with the notice and other provisions required by the GPL License.  
23  If you do not delete the provisions above, a recipient may use your version of 
24  this file under either the MPL or the GPL. 
25   */
26  package ca.uhn.hl7v2.validation;
27  
28  import ca.uhn.hl7v2.HL7Exception;
29  
30  /**
31   * Handler that is called for every violation during a message validation.
32   * <p>
33   * Instances of this class are NOT thread safe as they collect data during the
34   * validation process.
35   * 
36   * @author Christian Ohr
37   */
38  public interface ValidationExceptionHandler<R> {
39  
40      /**
41       * Called in case of validation rule violations.
42       * @param exceptions the exceptions that describe the validatin errors
43       */
44      void onExceptions(ValidationException... exceptions);
45  
46      /**
47       * Returns an overall validation result based on an aggregation of all
48       * exceptions thrown during the validation process. Often, this is a simple
49       * value indicating if any ValidationException has been thrown, but it can
50       * also be a complete response message that reflects the validation results.
51       *
52       * @return the validation result
53       * @throws HL7Exception if an error occurred during calculating the result
54       */
55      R result() throws HL7Exception;
56  
57  	/**
58  	 * Should be called before validation starts. Some ValidationHandler implementations
59  	 * may need context information of the subject being validated
60  	 * 
61  	 * @param subject subject to be validated
62  	 */
63  	void setValidationSubject(Object subject);
64  
65      /**
66       * Returns a boolean flag indicating whether a validation was successful or not.
67       * This is independent of {@link #result()} which may return a more complex
68       * object.
69       * @return true if the validation is considered to be failed.
70       */
71  	boolean hasFailed();
72  
73  }