com.filenet.rm.bds.exception

Class ErrorFrame

  1. java.lang.Object
  2. extended bycom.filenet.rm.bds.exception.ErrorFrame

  1. public class ErrorFrame
  2. extends java.lang.Object
This class represents the error frame portion of the transport error/exception reporting mechanism. It is contained within the ErrorStack class.

Constructor Summary

Constructor and Description
ErrorFrame(java.lang.String source,java.lang.String description)
Constructor.
ErrorFrame(java.lang.String source,java.lang.String description,java.util.Collection diagnostics)
Constructor.

Method Summary

Modifier and Type Method and Description
  1. void
addDiagnostic(Diagnostic diagnostic)
Appends a new Diagnosticinstance to this ErrorFrame.
  1. java.lang.String
getDescription()
The ErrorFrame description string.
  1. Diagnostic[]
getDiagnostics()
The ErrorFrame contained Diagnostic collection.
  1. java.lang.String
getSource()
The ErrorFrame source string.
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorFrame

  1. public ErrorFrame(java.lang.String source,
  2. java.lang.String description)
Constructor.
Parameters:
source - source String. Can be empty or null.
description - description String. Can be empty or null.

ErrorFrame

  1. public ErrorFrame(java.lang.String source,
  2. java.lang.String description,
  3. java.util.Collection diagnostics)
Constructor.
Parameters:
source - source String. Can be empty or null.
description - description String. Can be empty or null.
diagnostics - Collection of Diagnostic instances contained within this ErrorFrame.

Method Detail

addDiagnostic

  1. public void addDiagnostic(Diagnostic diagnostic)
Appends a new Diagnostic instance to this ErrorFrame.
Parameters:
diagnostic - the Diagnostic to append.

getSource

  1. public java.lang.String getSource( )
The ErrorFrame source string.
Returns:
the source String. Can be empty or null.

getDescription

  1. public java.lang.String getDescription( )
The ErrorFrame description string.
Returns:
the description String. Can be empty or null.

getDiagnostics

  1. public Diagnostic[] getDiagnostics( )
The ErrorFrame contained Diagnostic collection.
Returns:
an array of Diagnostic instances. Can be empty or null.