Collaboration API Documentation

com.filenet.bso.api.util
Class CollaborationOperationException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.filenet.bso.api.util.BsoChainingException
                    |
                    +--com.filenet.bso.api.util.CollaborationOperationException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ClbOpMissingEmailException

public class CollaborationOperationException
extends com.filenet.bso.api.util.BsoChainingException

The base class for Collaboration (workflow) Operations checked exceptions.

See Also:
Serialized Form

Constructor Summary
CollaborationOperationException()
          Constructs a CollaborationOperationException with no specific detail message.
CollaborationOperationException(java.lang.String msg)
          Constructs a CollaborationOperationException with a given detail message.
CollaborationOperationException(java.lang.String msg, java.lang.Throwable cause)
          Constructs a CollaborationOperationException with a given detail message and the original exception.
CollaborationOperationException(java.lang.Throwable cause)
          Constructs a CollaborationOperationException with an original throwable exception.
 
Method Summary
 java.lang.Throwable getCause()
          Returns the cause of this throwable or null if the cause is nonexistent or unknown.
 java.lang.Throwable initCause(java.lang.Throwable cause)
          Initializes the cause of this BsoException to the specified value.
 void printStackTrace()
          Prints the stack trace.
 void printStackTrace(java.io.PrintStream s)
          Prints the stack trace to a given PrintStream.
 void printStackTrace(java.io.PrintWriter s)
          Prints the stack trace to a given PrintWriter.
 void printStackTraceAsCause(java.io.PrintStream s)
          Prints the stack trace of the causing exception.
 void printStackTraceAsCause(java.io.PrintWriter s)
          Prints the stack trace of the causing exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CollaborationOperationException

public CollaborationOperationException()
Constructs a CollaborationOperationException with no specific detail message. This exception and exceptions derived from it are checked exceptions which must be specified in a throws clause or caught.

CollaborationOperationException

public CollaborationOperationException(java.lang.String msg)
Constructs a CollaborationOperationException with a given detail message.
Parameters:
msg - The detailed message.

CollaborationOperationException

public CollaborationOperationException(java.lang.Throwable cause)
Constructs a CollaborationOperationException with an original throwable exception.
Parameters:
cause - The original throwable exception. Can be null.

CollaborationOperationException

public CollaborationOperationException(java.lang.String msg,
                                       java.lang.Throwable cause)
Constructs a CollaborationOperationException with a given detail message and the original exception.

If you specify null for the e parameter, constructs the exception with only the detail message, which is equivalent to calling CollaborationOperationException(msg).

Parameters:
msg - The detailed message.

cause - The original throwable exception. Can be null.
Method Detail

initCause

public java.lang.Throwable initCause(java.lang.Throwable cause)
Initializes the cause of this BsoException to the specified value. (The cause is the throwable that caused this BsoException to get thrown.)
Parameters:
cause - The Throwable exception or cause for this exception (which is saved for later retrieval by the BsoChainingException.getCause() method). A null value is permitted, and indicates that the cause is nonexistent or unknown.
Returns:
a reference to this exception

getCause

public java.lang.Throwable getCause()
Returns the cause of this throwable or null if the cause is nonexistent or unknown. (The cause is the throwable that caused this throwable to get thrown.)
Returns:
The cause of this throwable or null if the cause is nonexistent or unknown.

printStackTrace

public void printStackTrace()
Prints the stack trace. This method prints the stack trace of the original exception, if there is one; if not, prints the stack trace of the current exception.
Overrides:
printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream s)
Prints the stack trace to a given PrintStream. This method prints the stack trace of the original exception, if there is one; if not, prints the stack trace of the current exception.
Overrides:
printStackTrace in class java.lang.Throwable
Parameters:
s - The Java PrintStream object to use.

printStackTraceAsCause

public void printStackTraceAsCause(java.io.PrintStream s)
Prints the stack trace of the causing exception. This current implementation is using JDK 1.3 Throwable.printStackTrace(). It tries to use the printStackTraceAsCause() if it exists on the cause class, otherwise uses the Throwable.printStackTrace().
Parameters:
s - PrintStream object which has a println method.

printStackTrace

public void printStackTrace(java.io.PrintWriter s)
Prints the stack trace to a given PrintWriter. This method prints the stack trace of the original exception, if there is one; if not, prints the stack trace of the current exception.

Overrides:
printStackTrace in class java.lang.Throwable
Parameters:
s - The Java PrintWriter object to use.

printStackTraceAsCause

public void printStackTraceAsCause(java.io.PrintWriter s)
Prints the stack trace of the causing exception. This current implementation is using JDK 1.3 Throwable.printStackTrace(). It tries to use the printStackTraceAsCause() if it exists on the cause class, otherwise uses the Throwable.printStackTrace().
Parameters:
s - PrintWriter object which has a println method.

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.