Package ca.uhn.hl7v2.validation

Interface MessageRule

All Superinterfaces:

Rule<Message>, Serializable

All Known Implementing Classes:

AbstractMessageRule, ChoiceElementsRespectedRule, ConformanceProfileRule, OnlyAllowableSegmentsInSuperstructureRule, OnlyKnownSegmentsRule, PredicateMessageRule, TerserMessageRule, VisitorMessageRule, WrongVersionRule

public interface MessageRule
extends Rule<Message>

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

Modifier and Type	Method	Description
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

apply, getDescription, getSectionReference

Method Details

test

ValidationException[] test(Message msg)

Tests the given (fully populated) message against the criteria defined by this rule class.

Parameters:

msg - message to be tested

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.