be.SIRAPRISE.messages

Class SiraPriseErrorMessageType

java.lang.Object

be.SIRAPRISE.messages.ServerMessageType

be.SIRAPRISE.messages.SiraPriseErrorMessageType

Direct Known Subclasses:

SiraPriseErrorMessageTypeV1_0, SiraPriseErrorMessageTypeV1_1

public abstract class SiraPriseErrorMessageType
extends ServerMessageType

The SiraPriseErrorMessageType is the message type returned by a SIRA_PRISE server in the event when any command issued by a client has resulted in a runtime error.

Author:

Erwin Smout

Field Summary

Fields

Modifier and Type	Field and Description
static int	MESSAGETYPEID The numeric ID for messages of this type (1497858657 )

Method Summary

Modifier and Type	Method and Description
SiraPriseErrorMessage	message(long errorNumber, java.lang.String message) Factory method for producing messages of this version of the message type, holding the given SIRA_PRISE runtime error description
abstract SiraPriseErrorMessage	message(long errorNumber, java.lang.String message, boolean fatal) Factory method for producing messages of this version of the message type, holding the given SIRA_PRISE runtime error description

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MESSAGETYPEID

public static final int MESSAGETYPEID

The numeric ID for messages of this type (1497858657 )

See Also:

Constant Field Values

Method Detail

message

public final SiraPriseErrorMessage message(long errorNumber,
                                           java.lang.String message)

Factory method for producing messages of this version of the message type, holding the given SIRA_PRISE runtime error description

Parameters:

errorNumber - The numeric ID of the runtime exception that occurred

message - The (formatted) error message as displayed to the client by SIRA_PRISE

Returns:

A SiraPriseErrorMessage of the appropriate version reflecting the given errorNumber and error message

message

public abstract SiraPriseErrorMessage message(long errorNumber,
                                              java.lang.String message,
                                              boolean fatal)

Factory method for producing messages of this version of the message type, holding the given SIRA_PRISE runtime error description

Parameters:

errorNumber - The numeric ID of the runtime exception that occurred

message - The (formatted) error message as displayed to the client by SIRA_PRISE

fatal - Indicates whether the exception was 'fatal', i.e. whether the server aborted its transaction as a consequence of the error

Returns:

A SiraPriseErrorMessage of the appropriate version reflecting the given errorNumber and error message