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 "MessageRule.java".  Description: 
010"A rule that applies to a fully populated message object. " 
011
012The Initial Developer of the Original Code is University Health Network. Copyright (C) 
0132002.  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*/
026
027package ca.uhn.hl7v2.validation;
028
029import ca.uhn.hl7v2.model.Message;
030
031/**
032 * A validation rule that applies to a fully populated message object.  Message rules 
033 * may be called (depending on runtime configuration) just after an inbound message
034 * is parsed, or just before an outbound message is encoded.  
035 * @author Bryan Tripp 
036 */
037public interface MessageRule extends Rule<Message> {
038    
039    /**
040     * Tests the given (fully populated) message against the criteria 
041     * defined by this rule class.
042     * @param msg message to be tested
043     * @return a list of exceptions indicating points at which the given 
044     *      message failed to validate (empty if validation succeeds; may 
045     *      not be a complete list as testing may be aborted after failure).  
046     *      The list should be empty if this rule is evaluated against a type 
047     *      of message to which it doesn't apply.  
048     */
049    public ValidationException[] test(Message msg);
050    
051}