com.oracle.bpel.client
Class BPELFault

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.oracle.bpel.client.BPELFault

All Implemented Interfaces:

java.io.Serializable

public class BPELFault

extends java.lang.Exception

This class represents a standard fault that may be thrown by the server during run-time. A BPEL fault has defined, minimally, a QName that corresponds to the fault name (there are several standard faults that are supported, please refer to Appendix A - Standard Faults in the BPEL 1.1 specification for a complete list).

This class can only be used from within a bpelx:exec activity; the throw activity can be used from BPEL code.

Additional information (such as a fault variable) can be passed through as a part. Currently, internal system errors populate error codes and summary messages via parts.

See Also:

Serialized Form

Constructor Summary

BPELFault(QName faultName)
Creates a new fault with a fault QName.

BPELFault(QName faultName, QName messageTypeQName)
Creates a new fault with fault name and message type QName.

Method Summary

QName	getFaultName() Returns the fault name.
java.lang.String	getMessage() Returns String with the fault name, message type QName and parts defined for this fault.
QName	getMessageType() Returns the message type QName.
java.lang.Object	getPart(java.lang.String name) Returns the part value with the specified name.
java.util.Map	getParts() Returns a map of parts.
void	setFaultName(QName faultName) Sets the fault name.
void	setMessageType(QName messageTypeQName) Sets the message type QName.
void	setPart(java.lang.String name, java.lang.Object value) Sets a part with the given name and value.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BPELFault

public BPELFault(QName faultName)

Creates a new fault with a fault QName.

BPELFault

public BPELFault(QName faultName,
                 QName messageTypeQName)

Creates a new fault with fault name and message type QName.

Method Detail

setFaultName

public void setFaultName(QName faultName)

Sets the fault name.

getFaultName

public QName getFaultName()

Returns the fault name.

setMessageType

public void setMessageType(QName messageTypeQName)

Sets the message type QName.

getMessageType

public QName getMessageType()

Returns the message type QName.

setPart

public void setPart(java.lang.String name,
                    java.lang.Object value)

Sets a part with the given name and value. The value will be converted to an XML element with the given name as tag name, if it is not already an XML element.

Parameters:

name - part name

getPart

public java.lang.Object getPart(java.lang.String name)

Returns the part value with the specified name.

getParts

public java.util.Map getParts()

Returns a map of parts.

getMessage

public java.lang.String getMessage()

Returns String with the fault name, message type QName and parts defined for this fault.