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 "ValidationContext.java".  Description: 
10  "A set of rules for message validation" 
11  
12  The Initial Developer of the Original Code is University Health Network. Copyright (C) 
13  2004.  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 java.util.Collection;
29  
30  import ca.uhn.hl7v2.model.Primitive;
31  
32  /**
33   * A set of rules for message validation.  
34   * 
35   * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
36   * @version $Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:41 $ by $Author: jamesagnew $
37   */
38  public interface ValidationContext {
39  
40      /**
41       * @param theVersion an HL7 version (eg "2.1")
42       * @param theTypeName a primitive datatype name (eg "ST")
43       * @param theType the Primitive being validated 
44       * @return active rules for checking the given type in the given version 
45       */
46      public Collection<PrimitiveTypeRule> getPrimitiveRules(String theVersion, String theTypeName, Primitive theType);
47  
48      /**
49       * @param theVersion an HL7 version (eg "2.1")
50       * @param theMessageType a value valid for MSH-9-1
51       * @param theTriggerEvent a value valid fro MSH-9-2
52       * @return the active rules that apply to message of the given version, message type, 
53       *      and trigger event 
54       */    
55      public Collection<MessageRule> getMessageRules(String theVersion, String theMessageType, String theTriggerEvent);
56      
57      /**
58       * @param theVersion an HL7 version (eg "2.1")
59       * @param theEncoding an encoding name (eg "VB", "XML)
60       * @return the active encoding rules that apply to the given version and encoding
61       */
62      public Collection<EncodingRule> getEncodingRules(String theVersion, String theEncoding);
63      
64  }