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