ca.uhn.hl7v2.validation
Interface MessageRule

All Superinterfaces:
Rule, java.io.Serializable
All Known Implementing Classes:
ConformanceProfileRule

public interface MessageRule
extends Rule

A validation rule that applies to a fully populated message object. Message rules may be called (depending on runtime configuration) just after an inbound message is parsed, or just before an outbound message is encoded.

Author:
Bryan Tripp

Method Summary
 ValidationException[] test(Message msg)
          Tests the given (fully populated) message against the criteria defined by this rule class.
 
Methods inherited from interface ca.uhn.hl7v2.validation.Rule
getDescription, getSectionReference
 

Method Detail

test

ValidationException[] test(Message msg)
Tests the given (fully populated) message against the criteria defined by this rule class.

Returns:
a list of exceptions indicating points at which the given message failed to validate (empty if validation succeeds; may not be a complete list as testing may be aborted after failure). The list should be empty if this rule is evaluated against a type of message to which it doesn't apply.


Copyright © 2001-2011 University Health Network. All Rights Reserved.