com.filenet.rm.bds.exception

Class ErrorFrame

  • java.lang.Object
    • com.filenet.rm.bds.exception.ErrorFrame


  • public class ErrorFrame
    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

      Constructors 
      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

      Methods 
      Modifier and Type Method and Description
      void addDiagnostic(Diagnostic diagnostic)
      Appends a new Diagnostic instance to this ErrorFrame.
      java.lang.String getDescription()
      The ErrorFrame description string.
      Diagnostic[] getDiagnostics()
      The ErrorFrame contained Diagnostic collection.
      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

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

        public ErrorFrame(java.lang.String source,
                  java.lang.String description,
                  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

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

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

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

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

© Copyright IBM Corp. 2006, 2013. All Rights Reserved.