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. 
009The Original Code is "Validator.java".  Description: 
010"Validates messages against message profiles." 
012The Initial Developer of the Original Code is University Health Network. Copyright (C) 
0132003.  All Rights Reserved. 
015Contributor(s): ______________________________________. 
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. 
028package ca.uhn.hl7v2.conf.check;
030import ca.uhn.hl7v2.conf.spec.message.StaticDef;
031import ca.uhn.hl7v2.model.Message ;
032import ca.uhn.hl7v2.conf.ProfileException;
033import ca.uhn.hl7v2.HL7Exception;
036 * Validates messages against message profiles. In general you use this by
037 * formulating a ConformanceProfileRule and validating a message using this rule.
038 *  
039 * @author Bryan Tripp
040 */
041public interface Validator {
043    /**
044     * Validates the given message against the given static definition from 
045     * a conformance profile.  Conformance profiles are XML representations of   
046     * domain-specific constraints on a message (see HL7 2.5 section 2.12).  
047     * @throws ProfileException if a problem is encountered that interferes with evaluation 
048     * @return a list of exceptions representing points of non-conformance (may not be a complete list)
049     */
050    public HL7Exception[] validate(Message message, StaticDef profile) throws ProfileException, HL7Exception;