com.ibm.bpe.api
Class ProcessError

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by com.ibm.bpe.api.ProcessError
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
EngineCompensationSphereNotCompletedError, EngineCompensationSphereStateUnknownError, EngineContainerAppNotReachableError, EngineCopyDataObjectError, EngineCreateDataObjectError, EngineEnforceRollbackError, EngineGetTypeError, EngineLookupProcessBeanError, EngineRollbackOnlyError, EngineStateObserverEventError, EngineWorkCompletionContractRollbackError, QueryTableError, QueryTableError

public class ProcessError
extends java.lang.RuntimeException

This is the base class for all Business Flow Manager runtime exceptions. Exceptions can include nested exceptions.

Since:
5.0
See Also:
Serialized Form

Field Summary
protected  java.lang.String _catalog
           
protected  java.lang.Throwable _cause
           
protected  java.lang.String _id
           
protected  java.lang.String _key
           
protected  java.lang.String _message
           
protected  java.lang.Object[] _vars
           
static java.lang.String COPYRIGHT
           
 
Constructor Summary
ProcessError(java.lang.String message)
          Constructs an error object from the error message passed.
ProcessError(java.lang.String key, java.lang.Object[] vars, java.lang.String id)
          Constructs an error object with the specified message key and remembers the values of the message variables passed.
ProcessError(java.lang.String key, java.lang.Object[] vars, java.lang.String id, java.lang.Throwable cause)
          Constructs an error object with the specified message key and exception and remembers the values of the message variables passed.
ProcessError(java.lang.String catalog, java.lang.String key, java.lang.Object[] vars, java.lang.String id, java.lang.Throwable cause)
          Constructs an error object with the specified message key and exception and remembers the values of the message variables passed.
ProcessError(java.lang.String message, java.lang.Throwable cause)
          Constructs an error object from the error message and exception passed.
ProcessError(java.lang.Throwable cause)
          Constructs an error object from the exception passed.
 
Method Summary
 java.lang.Throwable getCause()
          Returns the nested exception.
 java.lang.String getMessage()
          Returns the message text of the error object.
 java.lang.String getMessage(java.util.Locale locale)
          Returns the message text of the error object.
 java.lang.String getMessageID()
          Returns the message id.
 java.lang.String getMessageKey()
          Returns the message key.
 java.lang.Object[] getMessageVariables()
          Returns the values of message variables.
 java.lang.Throwable getRootCause()
          Returns the root exception of this error.
 void internPrintStackTrace(java.io.PrintWriter s)
          Prints this exception to the specified print writer.
 void printStackTrace()
          Prints this exception to the standard error stream.
 void printStackTrace(java.io.PrintStream s)
          Prints this exception to the specified print stream.
 void printStackTrace(java.io.PrintWriter s)
          Prints this exception to the specified print writer.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

_catalog

protected java.lang.String _catalog

_message

protected java.lang.String _message

_key

protected java.lang.String _key

_vars

protected java.lang.Object[] _vars

_id

protected java.lang.String _id

_cause

protected java.lang.Throwable _cause
Constructor Detail

ProcessError

public ProcessError(java.lang.String message)
Constructs an error object from the error message passed.

Parameters:
message - The error message.

ProcessError

public ProcessError(java.lang.Throwable cause)
Constructs an error object from the exception passed.

Parameters:
cause - The exception that was thrown.

ProcessError

public ProcessError(java.lang.String message,
                    java.lang.Throwable cause)
Constructs an error object from the error message and exception passed.

Parameters:
message - The error message.
cause - The exception that was thrown.

ProcessError

public ProcessError(java.lang.String key,
                    java.lang.Object[] vars,
                    java.lang.String id)
Constructs an error object with the specified message key and remembers the values of the message variables passed. The error message can thus localize the cause of the error.

Parameters:
key - The message key.
vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.
id - The message id.

ProcessError

public ProcessError(java.lang.String key,
                    java.lang.Object[] vars,
                    java.lang.String id,
                    java.lang.Throwable cause)
Constructs an error object with the specified message key and exception and remembers the values of the message variables passed. The error message can thus localize the cause of the error.

Parameters:
key - The message key.
vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.
id - The message id.
cause - The exception that was thrown.

ProcessError

public ProcessError(java.lang.String catalog,
                    java.lang.String key,
                    java.lang.Object[] vars,
                    java.lang.String id,
                    java.lang.Throwable cause)
Constructs an error object with the specified message key and exception and remembers the values of the message variables passed. The error message can thus localize the cause of the error.

Parameters:
catalog - The catalog which have to be used to retrieve the message.
key - The message key.
vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.
id - The message id.
cause - The exception that was thrown.
Method Detail

getMessage

public final java.lang.String getMessage()
Returns the message text of the error object. If the error object contains a message key, the message text is returned in the default language.

Overrides:
getMessage in class java.lang.Throwable
Returns:
The message text.

getMessage

public java.lang.String getMessage(java.util.Locale locale)
Returns the message text of the error object. If the error object contains a message key, the message text is returned in the specified language.

Parameters:
locale - The locale of the message catalog to be used. Is ignored if the error object does not contain a message key.
Returns:
The message text.

getMessageKey

public final java.lang.String getMessageKey()
Returns the message key.

Returns:
The message key. null is returned if a message key is not specified.

getMessageID

public final java.lang.String getMessageID()
Returns the message id.

Returns:
String - The message id. If a message id is not specified, null is returned.

getMessageVariables

public final java.lang.Object[] getMessageVariables()
Returns the values of message variables.

Returns:
The array of variable values. An empty array is returned if there are no variable values.

getCause

public final java.lang.Throwable getCause()
Returns the nested exception.

Overrides:
getCause in class java.lang.Throwable
Returns:
The nested exception. null is returned if there is no nested exception.

getRootCause

public final java.lang.Throwable getRootCause()
Returns the root exception of this error.

Returns:
The root exception.

printStackTrace

public final void printStackTrace()
Prints this exception to the standard error stream. This call is forwarded to printStackTrace(PrintWriter).

Overrides:
printStackTrace in class java.lang.Throwable

printStackTrace

public final void printStackTrace(java.io.PrintStream s)
Prints this exception to the specified print stream. This call is forwarded to printStackTrace(PrintWriter).

Overrides:
printStackTrace in class java.lang.Throwable
Parameters:
s - The print stream to write to.

printStackTrace

public final void printStackTrace(java.io.PrintWriter s)
Prints this exception to the specified print writer. If this exception has nested exceptions, the root exception's stack trace is printed.

Overrides:
printStackTrace in class java.lang.Throwable
Parameters:
s - The print writer to write to.

internPrintStackTrace

public final void internPrintStackTrace(java.io.PrintWriter s)
Prints this exception to the specified print writer. Qualifier changed from protected to public because of split-package issues between core and common bundle.

Parameters:
s - The print writer to write to.