|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.exception.ErrorRecord
public class ErrorRecord
Represents a single exception that has occurred on the server. When the server returns an exception to the client
it converts each chained exception into an ErrorRecord object and places it in an error stack (ErrorStack
).
ErrorStack
,
EngineRuntimeException
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
DIAGNOSTIC_EXCEPTION_CODE
When the exception is an EngineRuntimeException instance, this field identifies the exception code. |
static java.lang.String |
DIAGNOSTIC_STACK_TRACE
Identifies the stack trace information for the exception. |
Constructor Summary | |
---|---|
ErrorRecord(java.lang.String source,
java.lang.String description,
java.util.HashMap diagnosticTypes)
Use this to create a record from exception data. |
|
ErrorRecord(java.lang.Throwable erte)
Use this to create a record for any exception. |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Gets the description string for the exception. |
java.util.HashMap |
getDiagnosticTypes()
Returns the key and associated value describing the specific details required to troubleshoot the exception. |
java.lang.String |
getSource()
Gets the name of the exception instance that occurred. |
java.lang.String |
toString()
Returns the details of the exception. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DIAGNOSTIC_STACK_TRACE
getDiagnosticTypes
and toString
.
public static final java.lang.String DIAGNOSTIC_EXCEPTION_CODE
EngineRuntimeException
instance, this field identifies the exception code.
This field is used by getDiagnosticTypes
and toString
.
Constructor Detail |
---|
public ErrorRecord(java.lang.Throwable erte)
EngineRuntimeException
instance cast as a
Throwable
object.
erte
- A java.lang.Throwable
object for either the exception, or the EngineRuntimeException
instance.public ErrorRecord(java.lang.String source, java.lang.String description, java.util.HashMap diagnosticTypes)
source
- A String
containing the name of the exception instance that occurred.description
- A String
containing a description of the exception.diagnosticTypes
- A HashMap
object containing the exception code string, and a string containing the
stack trace information (from java.lang.Throwable.getStackTrace
) for this exception.Method Detail |
---|
public java.lang.String getDescription()
String
containing the exception description. For an EngineRuntimeException instance, the text
is localized to the client locale (either the default locale of the client JVM or the locale that has been set
in the UserContext object).public java.lang.String getSource()
String
containing the instance name of the exception.public java.util.HashMap getDiagnosticTypes()
HashMap
object containing the exception code string, and a string containing the
stack trace information (from java.lang.Throwable.getStackTrace
) for this exception.public java.lang.String toString()
toString
in class java.lang.Object
String
representation of the exception.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |