oracle.ifs.fdk

Class FdkExceptionEntry

java.lang.Object

oracle.ifs.fdk.FdkExceptionEntry

All Implemented Interfaces:

Serializable

public class FdkExceptionEntry
extends Object
implements Serializable

An entry when the exception is an aggregate exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FdkExceptionEntry() Constructor required to be a Java Bean.
FdkExceptionEntry(AggregateExceptionEntry aee) Constructor.

Method Summary

Modifier and Type	Method and Description
Throwable	cause() Returns the cause exception of this entry or null if the entry was not caused by another exception.
static FdkExceptionEntry[]	convert(Throwable t) Converts a Throwable into an FdkExceptionEntry[].
String	getDetailedErrorCode() Returns the detailed error code that may provide more information about the error.
String	getErrorCode() Returns the main error code.
long	getId() Returns the ID of the item for which the error occured.
NamedValue[]	getInfo() Returns additional information about the error or null if no additional information is available.
String	getServerStackTraceId() Returns the server stack trace ID for this entry.
Map	infoMap() Returns additional information about the error or null if no additional information is available.
void	setDetailedErrorCode(String errorCode) Always throws a RuntimeException.
void	setErrorCode(String errorCode) Always throws a RuntimeException.
void	setId(long id) Always throws a RuntimeException.
void	setInfo(NamedValue[] info) Always throws a RuntimeException.
void	setServerStackTraceId(String id) Always throws a RuntimeException.
String	toString() Returns a string representation of this entry without the stack trace of the cause exception.
String	toStringWithStackTrace() Returns a string representation of this entry with the stack trace of the cause exception, if any.

Methods inherited from class java.lang.Object

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

Constructor Detail

FdkExceptionEntry

public FdkExceptionEntry()

Constructor required to be a Java Bean. Do not use it, it will always throw RuntimeException.

Throws:

RuntimeException - Always.

FdkExceptionEntry

public FdkExceptionEntry(AggregateExceptionEntry aee)

Constructor.

Parameters:

aee - The AggregateExceptionEntry this entry corresponds to.

(Unpublished)

Method Detail

convert

public static FdkExceptionEntry[] convert(Throwable t)

Converts a Throwable into an FdkExceptionEntry[]. If the Throwable is an aggregate exception, the entries will be mapped and the returned array will most likely have its length > 1. If the Throwable is not an aggregate exception, the returned array will have length exactly 1.

Note that this method will not log any exceptions to the log file, including severe or server errors. It is the responsibility of the caller to do such logging if desired.

Parameters:

t - The Throwable to convert.

(Unpublished)

getErrorCode

public String getErrorCode()

Returns the main error code.

setErrorCode

public void setErrorCode(String errorCode)

Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.

Throws:

RuntimeException - Always.

getDetailedErrorCode

public 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.

setDetailedErrorCode

public void setDetailedErrorCode(String errorCode)

Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.

Throws:

RuntimeException - Always.

getId

public long getId()

Returns the ID of the item for which the error occured.

setId

public void setId(long id)

Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.

Throws:

RuntimeException - Always.

getInfo

public NamedValue[] getInfo()

Returns additional information about the error or null if no additional information is available.

infoMap

public Map infoMap()

Returns additional information about the error or null if no additional information is available. The result is the same as calling getInfo() except the return type is a Map for convenience.

(Unpublished)

setInfo

public void setInfo(NamedValue[] info)

Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.

Throws:

RuntimeException - Always.

getServerStackTraceId

public String getServerStackTraceId()

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

setServerStackTraceId

public void setServerStackTraceId(String id)

Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.

Throws:

RuntimeException - Always.

cause

public Throwable cause()

Returns the cause exception of this entry or null if the entry was not caused by another exception.

(Unpublished)

toString

public String toString()

Returns a string representation of this entry without the stack trace of the cause exception. Logging the result of this method should be guarded by the log level as the string computation is significant.

Overrides:

toString in class Object

toStringWithStackTrace

public String toStringWithStackTrace()

Returns a string representation of this entry with the stack trace of the cause exception, if any. Logging the result of this method should be guarded by the log level as the string computation is significant.

(Unpublished)