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