com.ibm.bpe.api
Class ProcessFaultException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended bycom.ibm.bpe.api.ProcessException
              extended bycom.ibm.bpe.api.ProcessFaultException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
EngineFaultHasBeenNavigatedException, EngineProcessCompensatedException, EngineUncaughtExceptionInProcessException

public class ProcessFaultException
extends ProcessException

Represents the exception that is passed to a user or a process activity when a non-interruptible process ends with a process fault.

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Constructor Summary
ProcessFaultException(java.lang.String message)
          Constructs an exception object from the error message passed.
ProcessFaultException(java.lang.String key, java.lang.Object[] vars)
          Constructs an exception object with the specified message key and remembers the values of the message variables passed.
ProcessFaultException(java.lang.String key, java.lang.Object[] vars, java.lang.Throwable cause)
          Constructs an exception object with the specified message key and exception and remembers the values of the message variables passed.
ProcessFaultException(java.lang.String message, java.lang.Throwable cause)
          Constructs an exception object from the error message and the exception passed.
ProcessFaultException(java.lang.Throwable cause)
          Constructs an exception object from the exception passed.
 
Method Summary
 ClientObjectWrapper getFaultMessage()
          Returns the fault message that describes the fault that occurred.
 void setFaultMessage(ClientObjectWrapper faultMessage)
          Sets the fault message that describes the fault that occurred.
 
Methods inherited from class com.ibm.bpe.api.ProcessException
getCause, getMessage, getMessage, getMessageKey, getMessageVariables, getRootCause, printStackTrace, printStackTrace, printStackTrace
 
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

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

ProcessFaultException

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

Parameters:
message - The error message.

ProcessFaultException

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

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

ProcessFaultException

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

Parameters:
cause - The exception that was thrown.

ProcessFaultException

public ProcessFaultException(java.lang.String key,
                             java.lang.Object[] vars)
Constructs an exception 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.

ProcessFaultException

public ProcessFaultException(java.lang.String key,
                             java.lang.Object[] vars,
                             java.lang.Throwable cause)
Constructs an exception 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.
cause - The exception that was thrown.
Method Detail

setFaultMessage

public void setFaultMessage(ClientObjectWrapper faultMessage)
Sets the fault message that describes the fault that occurred.

Parameters:
faultMessage - The process fault message.

getFaultMessage

public ClientObjectWrapper getFaultMessage()
Returns the fault message that describes the fault that occurred.

Returns:
ClientObjectWrapper - The process fault message.