Skip navigation links

oracle.ifs.fdk
Class FdkException

java.lang.Object
java.lang.Throwable
java.lang.Exception
oracle.ifs.fdk.FdkException

All Implemented Interfaces:

java.io.Serializable

public class FdkException

extends java.lang.Exception

implements java.io.Serializable

The exception thrown by the framework.

Method Summary

java.lang.String	getDetailedErrorCode() Returns the detailed error code that may provide more information about the error.
java.lang.String	getErrorCode() Returns the main error code.
FdkExceptionEntry[]	getExceptionEntries() If this is an aggregate exception, it will return the individual entries, otherwise it returns null.
NamedValue[]	getInfo() Returns the optional info for this error.
java.lang.String	getServerStackTraceId() Returns the server stack trace ID for this exception.
void	printStackTrace(java.io.PrintWriter pw) Prints the stack trace of this FdkException to the specified PrintWriter.
java.lang.String	toString() Returns a minimal string representation of this exception (ERROR_CODE:DETAILED_ERROR_CODE).

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getErrorCode

public java.lang.String getErrorCode()

Returns the main error code.

getDetailedErrorCode

public java.lang.String getDetailedErrorCode()

Returns the detailed error code that may provide more information about the error. If a detailed error code is not available, the same value as the main error code will be returned.

getInfo

public NamedValue[] getInfo()

Returns the optional info for this error.

getServerStackTraceId

public java.lang.String getServerStackTraceId()

Returns the server stack trace ID for this exception. This method is useful when invoking the API remotely. For in-process calls the cause exception (if any) is always available by calling getCause().

getExceptionEntries

public FdkExceptionEntry[] getExceptionEntries()

If this is an aggregate exception, it will return the individual entries, otherwise it returns null.

toString

public java.lang.String toString()

Returns a minimal string representation of this exception (ERROR_CODE:DETAILED_ERROR_CODE). For a detailed string representation see toLogString()

printStackTrace

public void printStackTrace(java.io.PrintWriter pw)

Prints the stack trace of this FdkException to the specified PrintWriter. This provides extra information for debugging.

Parameters:

pw - The PrintWriter to write to.

Skip navigation links