com.highdeal.error

Interface IError

public interface IError

This Java interface defines an error in a specific 'module' of the SAP CC software; An error is identified uniquely thanks to a module name and a numeric code.

An error can:

• Define a set of optional arguments
• Include a comprehensive message that describes the error in plain text
• Relate to a cause error; Errors are linked one to another thanks to this causality.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IError.ErrorType This enumeration defines the available types or errors, which can be: Permanent error: this error is permanent; it will lead to a failure each time the process is called Temporary error: this error is temporary; the process has to be called again later Correction expected: this error is temporary; but will lead to a failure until correction has not been applied

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	getArguments() Gets the arguments of the error.
IError	getCause() Gets the cause error that relates to this error; This method returns null if the error has no root cause.
int	getCode() Gets the numeric code of the error; With the module, it uniquely identifies the error.
java.lang.String	getMessage() Gets the comprehensive message for this error.
java.lang.String	getModule() Gets the software module where the error happened; With the numeric code, it uniquely identifies the error.
IError	setCause(IError cause) Sets the the cause error relating to this error.

Method Detail

getModule

java.lang.String getModule()

Gets the software module where the error happened; With the numeric code, it uniquely identifies the error.

Returns:

The software module where the error happened

getCode

int getCode()

Gets the numeric code of the error; With the module, it uniquely identifies the error.

Returns:

The numeric code of the error

getArguments

java.lang.Object[] getArguments()

Gets the arguments of the error. If the error has no argument, an empty array is returned.

Note

This method never returns null.

Returns:

The array of arguments; This array can be empty.

getMessage

java.lang.String getMessage()

Gets the comprehensive message for this error.

Returns:

The human-readable message for this error

getCause

IError getCause()

Gets the cause error that relates to this error; This method returns null if the error has no root cause.

Returns:

The cause error relating to this error

setCause

IError setCause(IError cause)

Sets the the cause error relating to this error.

Parameters:

cause - The cause error that relates to this error

Returns:

The current error linked now with its cause error