be.SIRAPRISE.messages

Class ServerErrorMessage

java.lang.Object

be.SIRAPRISE.messages.ServerMessage

be.SIRAPRISE.messages.ServerErrorMessage

Direct Known Subclasses:

ConstraintViolatedErrorMessage, NonSiraPriseErrorMessage, SiraPriseErrorMessage

public abstract class ServerErrorMessage
extends ServerMessage

A ServerErrorMessage is any kind of message holding an indication that some kind of error has occurred on the server side. It can be subclassed to create "classes of server errors", each with their own specifics.

Author:

Erwin Smout

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientResponseText() Gets The response text to be shown to the client/user
abstract java.lang.String	getErrorClass() Gets a description of the error class
long	getErrorNumber() Gets The error number, whether a constraint number, a sira-prise runtime error, or a nil
java.lang.String	getOriginalExceptionMessage() Gets the server's original exception message
boolean	isFatal() Gets a flag indicating whether the error was 'fatal', i.e.

Methods inherited from class be.SIRAPRISE.messages.ServerMessage

getMessageTypeID, readMessage, sendMessage

Methods inherited from class java.lang.Object

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

Method Detail

getClientResponseText

public final java.lang.String getClientResponseText()

Gets The response text to be shown to the client/user

Returns:

The response text to be shown to the client/user

getErrorClass

public abstract java.lang.String getErrorClass()

Gets a description of the error class

Returns:

a description of the error class

getErrorNumber

public final long getErrorNumber()

Gets The error number, whether a constraint number, a sira-prise runtime error, or a nil

Returns:

The error number, whether a constraint number, a sira-prise runtime error, or a nil

getOriginalExceptionMessage

public final java.lang.String getOriginalExceptionMessage()

Gets the server's original exception message

Returns:

the server's original exception message

isFatal

public final boolean isFatal()

Gets a flag indicating whether the error was 'fatal', i.e. whether the server has aborted its side of the transaction as a consequence of the error

Returns:

Flag indicating whether the error was 'fatal', i.e. whether the server has aborted its side of the transaction as a consequence of the error