001    /**
002    The contents of this file are subject to the Mozilla Public License Version 1.1 
003    (the "License"); you may not use this file except in compliance with the License. 
004    You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
005    Software distributed under the License is distributed on an "AS IS" basis, 
006    WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
007    specific language governing rights and limitations under the License. 
008    
009    The Original Code is "ValidationContext.java".  Description: 
010    "A set of rules for message validation" 
011    
012    The Initial Developer of the Original Code is University Health Network. Copyright (C) 
013    2004.  All Rights Reserved. 
014    
015    Contributor(s): ______________________________________. 
016    
017    Alternatively, the contents of this file may be used under the terms of the 
018    GNU General Public License (the  ?GPL?), in which case the provisions of the GPL are 
019    applicable instead of those above.  If you wish to allow use of your version of this 
020    file only under the terms of the GPL and not to allow others to use your version 
021    of this file under the MPL, indicate your decision by deleting  the provisions above 
022    and replace  them with the notice and other provisions required by the GPL License.  
023    If you do not delete the provisions above, a recipient may use your version of 
024    this file under either the MPL or the GPL. 
025    */
026    package ca.uhn.hl7v2.validation;
027    
028    import ca.uhn.hl7v2.model.Primitive;
029    
030    /**
031     * A set of rules for message validation.  
032     * 
033     * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
034     * @version $Revision: 1.1 $ updated on $Date: 2007/02/19 02:24:41 $ by $Author: jamesagnew $
035     */
036    public interface ValidationContext {
037    
038        /**
039         * @param theVersion an HL7 version (eg "2.1")
040         * @param theTypeName a primitive datatype name (eg "ST")
041         * @param theType the Primitive being validated 
042         * @return active rules for checking the given type in the given version 
043         */
044        public PrimitiveTypeRule[] getPrimitiveRules(String theVersion, String theTypeName, Primitive theType);
045    
046        /**
047         * @param theVersion an HL7 version (eg "2.1")
048         * @param theMessageType a value valid for MSH-9-1
049         * @param theTriggerEvent a value valid fro MSH-9-2
050         * @return the active rules that apply to message of the given version, message type, 
051         *      and trigger event 
052         */    
053        public MessageRule[] getMessageRules(String theVersion, String theMessageType, String theTriggerEvent);
054        
055        /**
056         * @param theVersion an HL7 version (eg "2.1")
057         * @param theEncoding an encoding name (eg "VB", "XML)
058         * @return the active encoding rules that apply to the given version and encoding
059         */
060        public EncodingRule[] getEncodingRules(String theVersion, String theEncoding);
061        
062    }