1 /**
2 The contents of this file are subject to the Mozilla Public License Version 1.1
3 (the "License"); you may not use this file except in compliance with the License.
4 You may obtain a copy of the License at http://www.mozilla.org/MPL/
5 Software distributed under the License is distributed on an "AS IS" basis,
6 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
7 specific language governing rights and limitations under the License.
8
9 The Original Code is "MessageRule.java". Description:
10 "A rule that applies to a fully populated message object. "
11
12 The Initial Developer of the Original Code is University Health Network. Copyright (C)
13 2002. All Rights Reserved.
14
15 Contributor(s): ______________________________________.
16
17 Alternatively, the contents of this file may be used under the terms of the
18 GNU General Public License (the "GPL"), in which case the provisions of the GPL are
19 applicable instead of those above. If you wish to allow use of your version of this
20 file only under the terms of the GPL and not to allow others to use your version
21 of this file under the MPL, indicate your decision by deleting the provisions above
22 and replace them with the notice and other provisions required by the GPL License.
23 If you do not delete the provisions above, a recipient may use your version of
24 this file under either the MPL or the GPL.
25 */
26
27 package ca.uhn.hl7v2.validation;
28
29 import ca.uhn.hl7v2.model.Message;
30
31 /**
32 * A validation rule that applies to a fully populated message object. Message rules
33 * may be called (depending on runtime configuration) just after an inbound message
34 * is parsed, or just before an outbound message is encoded.
35 * @author Bryan Tripp
36 */
37 public interface MessageRule extends Rule<Message> {
38
39 /**
40 * Tests the given (fully populated) message against the criteria
41 * defined by this rule class.
42 * @param msg message to be tested
43 * @return a list of exceptions indicating points at which the given
44 * message failed to validate (empty if validation succeeds; may
45 * not be a complete list as testing may be aborted after failure).
46 * The list should be empty if this rule is evaluated against a type
47 * of message to which it doesn't apply.
48 */
49 ValidationException[] test(Message msg);
50
51 }