com.ibm.task.api

Class FaultReplyException

  1. java.lang.Object
  2. extended byjava.lang.Throwable
  3. extended byjava.lang.Exception
  4. extended bycom.ibm.task.api.TaskException
  5. extended bycom.ibm.task.api.FaultReplyException
All implemented interfaces:
java.io.Serializable

  1. public class FaultReplyException
  2. 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

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Constructor Summary

Constructor and Description
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

Modifier and Type Method and Description
  1. java.io.Serializable
getFaultMessage()
Returns the fault message.
  1. java.lang.String
getFaultMessageTypeLocalName()
Returns the fault message type local name.
  1. java.lang.String
getFaultMessageTypeNamespace()
Returns the fault message type namespace
  1. java.lang.String
getFaultName()
Returns the fault name.
  1. 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

  1. public static final java.lang.String COPYRIGHT
See Also:

Constructor Detail

FaultReplyException

  1. public FaultReplyException(java.lang.Object[] vars,
  2. java.lang.String faultName,
  3. java.lang.String faultMsgTypeNamespace,
  4. java.lang.String faultMsgTypeLocalName,
  5. java.io.Serializable faultMessage,
  6. 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

  1. public java.lang.String getFaultMessageTypeNamespace( )
Returns the fault message type namespace
Returns:
String - The fault message type namespace

getFaultMessageTypeLocalName

  1. public java.lang.String getFaultMessageTypeLocalName( )
Returns the fault message type local name.
Returns:
String - The fault message type local name.

getFaultName

  1. public java.lang.String getFaultName( )
Returns the fault name.
Returns:
String - The fault name.

getFaultMessage

  1. public java.io.Serializable getFaultMessage( )
  2. 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

  1. public void setFaultMessage(java.io.Serializable faultMessage,
  2. 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.