com.ibm.task.api
Class FaultReplyException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.task.api.TaskException
              extended by com.ibm.task.api.FaultReplyException
All Implemented Interfaces:
java.io.Serializable

public class FaultReplyException
extends TaskException

A FaultReplyException states that a modelled fault is returned. The transaction is committed.

Since:
6.0.2
See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
 
Constructor Summary
FaultReplyException(java.lang.Object[] vars, java.lang.String faultName, java.lang.String faultMsgTypeNamespace, java.lang.String faultMsgTypeLocalName, 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 getFaultMessageTypeLocalName()
          Returns the fault message type local name.
 java.lang.String getFaultMessageTypeNamespace()
          Returns the fault message type namespace
 java.lang.String getFaultName()
          Returns the fault name.
 void setFaultMessage(java.io.Serializable faultMessage, java.lang.String applicationName)
          Wraps the fault message into a ClientObjectWrapper object.
 
Methods inherited from class com.ibm.task.api.TaskException
getCause, getMessage, getMessage, getMessageID, 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

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.lang.String faultMsgTypeNamespace,
                           java.lang.String faultMsgTypeLocalName,
                           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.
faultMsgTypeNamespace - The fault message type namespace
faultMsgTypeLocalName - The fault message type local name
faultMessage - The fault message.
applicationName - The application that contains the modelled fault.
Method Detail

getFaultMessageTypeNamespace

public java.lang.String getFaultMessageTypeNamespace()
Returns the fault message type namespace

Returns:
String - The fault message type namespace

getFaultMessageTypeLocalName

public java.lang.String getFaultMessageTypeLocalName()
Returns the fault message type local name.

Returns:
String - The fault message type local name.

getFaultName

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

Returns:
String - The fault name.

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.

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.