com.ibm.bpe.api
Class FaultReplyException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.bpe.api.ProcessException
              extended by com.ibm.bpe.api.BpelException
                  extended by com.ibm.bpe.api.FaultReplyException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
FaultReplyException2, SpecificFaultReplyException

public class FaultReplyException
extends BpelException

A FaultReplyException states that a modelled fault is returned.

Since:
5.1
See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class com.ibm.bpe.api.BpelException
NAMESPACE_BPEL, NAMESPACE_WPC
 
Fields inherited from class com.ibm.bpe.api.ProcessException
_catalog, _cause, _id, _key, _message, _vars
 
Constructor Summary
FaultReplyException(java.lang.Object[] vars, java.lang.String faultName, java.io.Serializable faultMessage)
          Deprecated.  
FaultReplyException(java.lang.Object[] vars, java.lang.String faultName, java.io.Serializable faultMessage, java.lang.String applicationName)
          Constructs an exception object with the specified fault name and message and remembers the values of the message variables passed.
 
Method Summary
 java.io.Serializable getFaultMessage()
          Returns the fault message.
 java.lang.String getFaultName()
          Returns the fault name.
 void setFaultMessage(java.io.Serializable faultMessage)
          Deprecated.  
 void setFaultMessage(java.io.Serializable faultMessage, java.lang.String applicationName)
          Wraps the fault message into a ClientObjectWrapper object.
 
Methods inherited from class com.ibm.bpe.api.ProcessException
getCause, getMessage, getMessage, getMessageID, getMessageKey, getMessageVariables, getRootCause, internPrintStackTrace, 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

COPYRIGHT

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

FaultReplyException

public FaultReplyException(java.lang.Object[] vars,
                           java.lang.String faultName,
                           java.io.Serializable faultMessage)
Deprecated. 

Constructs an exception object with the specified fault name and message and remembers the values of the message variables passed. The fault message can thus localize the cause of the error.

Parameters:
vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.
faultName - The fault name.
faultMessage - The fault message.

FaultReplyException

public FaultReplyException(java.lang.Object[] vars,
                           java.lang.String faultName,
                           java.io.Serializable faultMessage,
                           java.lang.String applicationName)
Constructs an exception object with the specified fault name and message and remembers the values of the message variables passed. The fault message can thus localize the cause of the error.

Parameters:
vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.
faultName - The fault name.
faultMessage - The fault message.
applicationName - The application that contains the modelled fault.
Method Detail

getFaultName

public java.lang.String getFaultName()
Returns the fault name.

Specified by:
getFaultName in class BpelException
Returns:
String - The fault name.

setFaultMessage

public void setFaultMessage(java.io.Serializable faultMessage)
Deprecated. 

Wraps the fault message into a ClientObjectWrapper object.

Parameters:
faultMessage - The fault message.

setFaultMessage

public void setFaultMessage(java.io.Serializable faultMessage,
                            java.lang.String applicationName)
Wraps the fault message into a ClientObjectWrapper object.

Parameters:
faultMessage - The fault message.
applicationName - The application that contains the modelled fault.

getFaultMessage

public java.io.Serializable getFaultMessage()
                                     throws DataHandlingException
Returns the fault message.

Returns:
Serializable - The message that is associated with the fault.
Throws:
DataHandlingException - Thrown if the message object cannot be deserialized.