ca.uhn.hl7v2.validation

Interface EncodingRule

All Superinterfaces:

Rule<String>, Serializable

All Known Implementing Classes:

AbstractEncodingRule, XMLSchemaRule

public interface EncodingRule
extends Rule<String>

A validation rule that applies to encoded message strings. Rules that apply to message content are not included in this category (they are MessageRules and are evaluated against parsed Message object). EncodingRules are intended for criteria that are specific to the encoded form of a message, e.g. "no empty tags in an XML message".

Author:

Bryan Tripp

Method Summary

Modifier and Type	Method and Description
ValidationException[]	test(String msg) Tests the given encoded message text against the criteria defined by this rule class.

Methods inherited from interface ca.uhn.hl7v2.validation.Rule

apply, getDescription, getSectionReference

Method Detail

test

ValidationException[] test(String msg)

Tests the given encoded message text 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).