ca.uhn.hl7v2.protocol

Interface AcceptValidator.AcceptRuling

Enclosing interface:

AcceptValidator

public static interface AcceptValidator.AcceptRuling

Represents a decision regarding whether a message can be initially accepted for further processing. As per HL7 specs, for original-mode messages, a message should be accepted at this stage if the system thinks it can handle the message based on MSH-9, 11, and 12 values (assuming these can be parsed). In enhanced mode, the above checks are optional. Also optional is a check for syntactical correctness. Mandatory checks include availability of safe storage and "interface status".

Version:

$Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:38 $ by $Author: jamesagnew $

Author:

Bryan Tripp

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACK_AR
static String	ACK_CA
static String	ACK_CE
static String	ACK_CR

Method Summary

Modifier and Type	Method and Description
String	getAckCode()
int	getErrorCode()
String[]	getReasons()
boolean	isAcceptable()

Field Detail

ACK_AR

static final String ACK_AR

See Also:

Constant Field Values

ACK_CA

static final String ACK_CA

See Also:

Constant Field Values

ACK_CE

static final String ACK_CE

See Also:

Constant Field Values

ACK_CR

static final String ACK_CR

See Also:

Constant Field Values

Method Detail

isAcceptable

boolean isAcceptable()

Returns:

true if the message can be accepted at the protocol stage.

getAckCode

String getAckCode()

Returns:

the ACK code corresponding to the ruling, if any. Ie "AR", "CE", "CR", or "CA". If in original mode, null is returned for non-"AR" situations. This is because only the application layer can tell whether the answer is "AE" or "AA".

getErrorCode

int getErrorCode()

Returns:

an error code from among the static fields of HL7Exception (if no error, HL7Exception.MESSAGE_ACCEPTED)

getReasons

String[] getReasons()

Returns:

zero or more reasons for rejecting a message (suitable for inclusion in a reply).