Class MessageErrorIndicator.FieldError

java.lang.Object

org.jpos.iso.MessageErrorIndicator.FieldError

Enclosing class:

MessageErrorIndicator

public static class MessageErrorIndicator.FieldError
extends Object

One error set within a MessageErrorIndicator field.

The wire layout is exactly 14 bytes:

• 2 ASCII digits — severity
• 4 ASCII digits — message error code
• 3 ASCII digits — data element number (001–128)
• 2 ASCII digits — sub-element (constructed DEs) or "00"
• 1 binary byte — dataset identifier (composite DEs) or 0x00
• 2 binary bytes — dataset bit or TLV tag (composite DEs) or 0x0000

Method Summary

Modifier and Type	Method	Description
static MessageErrorIndicator.FieldError	compositeError(MessageErrorIndicator.ErrorCode errorCode, int deNumber, int datasetIdentifier, int datasetBitOrTag)	Creates an error set for a sub-element within a composite (dataset) data element.
static MessageErrorIndicator.FieldError	constructedError(MessageErrorIndicator.ErrorCode errorCode, int deNumber, int subElement)	Creates an error set for a sub-element within a constructed data element.
int	datasetBitOrTag()	Returns the DBM bit number or BER-TLV tag for composite data elements.
int	datasetIdentifier()	Returns the dataset identifier byte for composite data elements.
int	deNumber()	Returns the data element number flagged by this error.
int	errorCode()	Returns the raw 4-digit error code value carried on the wire.
MessageErrorIndicator.ErrorCode	errorCodeEnum()	Returns the MessageErrorIndicator.ErrorCode matching errorCode(), if any.
byte[]	pack()	Serializes this error set to exactly 14 bytes.
static MessageErrorIndicator.FieldError	primitiveError(MessageErrorIndicator.ErrorCode errorCode, int deNumber)	Creates an error set for a primitive data element.
static MessageErrorIndicator.FieldError	primitiveError(MessageErrorIndicator.Severity severity, MessageErrorIndicator.ErrorCode errorCode, int deNumber)	Creates an error set for a primitive data element with a specified severity.
MessageErrorIndicator.Severity	severity()	Returns the severity of this error set.
int	subElement()	Returns the sub-element number for constructed data elements.
String	toString()
static MessageErrorIndicator.FieldError	withRawCode(MessageErrorIndicator.Severity severity, int errorCode, int deNumber)	Creates an error set with a raw numeric error code (for private-use or national-use codes outside the ISO-defined MessageErrorIndicator.ErrorCode enum).

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

primitiveError

public static MessageErrorIndicator.FieldError primitiveError(MessageErrorIndicator.ErrorCode errorCode,
 int deNumber)

Creates an error set for a primitive data element.

Parameters:

errorCode - error code

deNumber - data element number (1–128)

Returns:

new error set

primitiveError

public static MessageErrorIndicator.FieldError primitiveError(MessageErrorIndicator.Severity severity,
 MessageErrorIndicator.ErrorCode errorCode,
 int deNumber)

Creates an error set for a primitive data element with a specified severity.

Parameters:

severity - error severity

errorCode - error code

deNumber - data element number (1–128)

Returns:

new error set

constructedError

public static MessageErrorIndicator.FieldError constructedError(MessageErrorIndicator.ErrorCode errorCode,
 int deNumber,
 int subElement)

Creates an error set for a sub-element within a constructed data element.

Parameters:

errorCode - error code

deNumber - data element number (1–128)

subElement - sub-element part number (1-based)

Returns:

new error set

compositeError

public static MessageErrorIndicator.FieldError compositeError(MessageErrorIndicator.ErrorCode errorCode,
 int deNumber,
 int datasetIdentifier,
 int datasetBitOrTag)

Creates an error set for a sub-element within a composite (dataset) data element.

Parameters:

errorCode - error code

deNumber - data element number (1–128)

datasetIdentifier - dataset identifier byte (0x01–0xFE)

datasetBitOrTag - DBM bit number or BER-TLV tag (packed into 2 bytes big-endian)

Returns:

new error set

withRawCode

public static MessageErrorIndicator.FieldError withRawCode(MessageErrorIndicator.Severity severity,
 int errorCode,
 int deNumber)

Creates an error set with a raw numeric error code (for private-use or national-use codes outside the ISO-defined MessageErrorIndicator.ErrorCode enum).

Parameters:

severity - error severity

errorCode - raw 4-digit error code (0001–9999)

deNumber - data element number (1–128)

Returns:

new error set

severity

public MessageErrorIndicator.Severity severity()

Returns the severity of this error set.

Returns:

error severity

errorCode

public int errorCode()

Returns the raw 4-digit error code value carried on the wire.

Returns:

message error code numeric value

errorCodeEnum

public MessageErrorIndicator.ErrorCode errorCodeEnum()

Returns the MessageErrorIndicator.ErrorCode matching errorCode(), if any.

Returns:

resolved MessageErrorIndicator.ErrorCode or null for private/national-use codes

deNumber

public int deNumber()

Returns the data element number flagged by this error.

Returns:

data element number in error

subElement

public int subElement()

Returns the sub-element number for constructed data elements.

Returns:

sub-element number (constructed DEs), 0 otherwise

datasetIdentifier

public int datasetIdentifier()

Returns the dataset identifier byte for composite data elements.

Returns:

dataset identifier (composite DEs), 0 otherwise

datasetBitOrTag

public int datasetBitOrTag()

Returns the DBM bit number or BER-TLV tag for composite data elements.

Returns:

dataset bit number or TLV tag (composite DEs), 0 otherwise

pack

public byte[] pack()

Serializes this error set to exactly 14 bytes.

Returns:

14-byte wire representation

toString

public String toString()

Overrides:

toString in class Object