com.canto.cumulus.exceptions

Class BaseRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.canto.cumulus.exceptions.BaseRuntimeException

All Implemented Interfaces:

CumulusExceptionDetails, java.io.Serializable

Direct Known Subclasses:

CumulusException, FieldNotFoundException, FunctionNotImplementedException, InvalidArgumentException, ItemNotFoundException, PermissionDeniedException, QueryParserException

public class BaseRuntimeException
extends java.lang.RuntimeException
implements CumulusExceptionDetails

The base class for all RuntimeExceptions of the CumulusJavaClasses. These exceptions, although declared for a method do not need to be caught by the caller. These exceptions are thrown for error conditions that the programmer can check before calling the method that throws the exception.

Since:

8.0

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
int	getErrorNumber() Returns the internal error number.
java.lang.String	getFileName() Returns the source file name where the error was reported from.
int	getLineNumber() Returns the source file line number where the error was reported from.
java.lang.String	getMessageFormatString() Returns the original message format string (may include %s as a placeholder for the message parameter).
java.lang.String	getMessageParam() Returns the original message parameter.
java.lang.String	getModuleName() Returns the module name where the error was reported from.
int	getNativeErrorNumber() Returns the Operating System specific error number.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Method Detail

getErrorNumber

public int getErrorNumber()

Returns the internal error number.

Specified by:

getErrorNumber in interface CumulusExceptionDetails

Returns:

the internal error number.

getNativeErrorNumber

public int getNativeErrorNumber()

Returns the Operating System specific error number.

Specified by:

getNativeErrorNumber in interface CumulusExceptionDetails

Returns:

the Operating System specific error number.

getFileName

public java.lang.String getFileName()

Returns the source file name where the error was reported from.

Specified by:

getFileName in interface CumulusExceptionDetails

Returns:

the source file name where the error was reported from.

getLineNumber

public int getLineNumber()

Returns the source file line number where the error was reported from.

Specified by:

getLineNumber in interface CumulusExceptionDetails

Returns:

the source file line number where the error was reported from.

getModuleName

public java.lang.String getModuleName()

Returns the module name where the error was reported from.

Specified by:

getModuleName in interface CumulusExceptionDetails

Returns:

the module name where the error was reported from.

getMessageFormatString

public java.lang.String getMessageFormatString()

Returns the original message format string (may include %s as a placeholder for the message parameter).

Specified by:

getMessageFormatString in interface CumulusExceptionDetails

Returns:

the original message format string.

getMessageParam

public java.lang.String getMessageParam()

Returns the original message parameter.

Specified by:

getMessageParam in interface CumulusExceptionDetails

Returns:

the original message parameter.