com.canto.cumulus.exceptions

Interface CumulusExceptionDetails

All Known Implementing Classes:

BaseException, BaseRuntimeException, CumulusException, FieldNotFoundException, FunctionNotImplementedException, InvalidArgumentException, ItemNotFoundException, LoginFailedException, PasswordExpiredException, PermissionDeniedException, QueryParserException, ServerNotFoundException, UnresolvableAssetReferenceException

public interface CumulusExceptionDetails

The interface that all Cumulus exceptions implement to provide detailed information.

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
int	getErrorNumber() Get the internal error number for the exception.
java.lang.String	getFileName() The name of the native source file that caused the exception.
int	getLineNumber() The line number inside the native source file for the line that caused the exception.
java.lang.String	getMessageFormatString() The format string used to build the error message.
java.lang.String	getMessageParam() The message parameter that is inserted into the format string to form the error message.
java.lang.String	getModuleName() The Cumulus module name where the exception was generated.
int	getNativeErrorNumber() Get the native (Operating System) error number for any error that was detected by a native system API call.

Method Detail

getErrorNumber

int getErrorNumber()

Get the internal error number for the exception. Together with the module name this error number has a specific meaning.

Returns:

The error number of the exception.

getNativeErrorNumber

int getNativeErrorNumber()

Get the native (Operating System) error number for any error that was detected by a native system API call.

Returns:

The native error number or 0 if the exception was not detected by a system call.

getFileName

java.lang.String getFileName()

The name of the native source file that caused the exception.

Returns:

The native source file name of the cause.

getLineNumber

int getLineNumber()

The line number inside the native source file for the line that caused the exception.

Returns:

The source file line number of the cause.

getModuleName

java.lang.String getModuleName()

The Cumulus module name where the exception was generated.

Returns:

The module name of the cause.

getMessageFormatString

java.lang.String getMessageFormatString()

The format string used to build the error message. typically this contains a placeholder where the message parameter is inserted.

Returns:

The error format string used.

getMessageParam

java.lang.String getMessageParam()

The message parameter that is inserted into the format string to form the error message.

Returns:

the additional error message parameter.