IT_Bus::FaultException Class Reference

#include <it_bus/fault_exception.h>

Inheritance diagram for IT_Bus::FaultException:

List of all members.

---

Detailed Description

Class representing a system fault.

This is a fault that can occur during an operation call. These are faults that are not defined in the WSDL contract and can happen for many types of reasons. The FaultException class contains a lot of state indicating what has happened. Users should catch FaultException in their client code and can take different actions depending on the category of their fault. Users can throw the FaultException in their Service/Servant implementation code.

Definition at line 337 of file fault_exception.h.

Public Member Functions
	FaultException ()
	Constructor.
	FaultException (const FaultException &copy)
	Copy Constructor.
virtual	~FaultException ()
	Destructor.
virtual Exception *	clone () const
	Clone the exception onto the heap.
virtual void	rethrow () const
	Rethrow the exception.
virtual void	read_contents (ComplexTypeReader &reader) throw ((DeserializationException))
	Read the member values into the instance.
virtual void	write_contents (ComplexTypeWriter &writer) const throw ((SerializationException))
	Write the member values of the instance.
virtual const QName &	get_type () const
	Returns the IT_Bus::QName for the type.
FaultException &	operator= (const FaultException &rhs)
virtual AnyType &	copy (const AnyType &assign)
	Returns a reference to an AnyType that is a copy of the AnyType parameter.
const FaultCategory &	get_category () const
	Get the category of the fault.
FaultCategory &	get_category ()
	Get the category of the fault.
void	set_category (const FaultCategory &val)
	Set the category of the fault.
const String &	get_namespace_uri () const
	Get the namespace of the originator of the fault.
String &	get_namespace_uri ()
	Get the namespace of the originator of the fault.
void	set_namespace_uri (const String &val)
	Set the namespace of the originator of the fault.
const FaultSource &	get_source () const
	Get the source of the Fault.
FaultSource &	get_source ()
	Get the source of the Fault Values could be CLIENT, SERVER or UNKNOWN.
void	set_source (const FaultSource &val)
	Set the source of the Fault Values could be CLIENT, SERVER or UNKNOWN.
const FaultCompletionStatus &	get_completion_status () const
	Get the completion status of operation when fault was raised.
FaultCompletionStatus &	get_completion_status ()
	Get the completion status of operation when fault was raised.
void	set_completion_status (const FaultCompletionStatus &val)
	Set the completion status of operation when fault was raised.
const String &	get_description () const
	Get the human readable description of the fault.
String &	get_description ()
	Get the human readable description of the fault.
void	set_description (const String &val)
	Set the human readable description of the fault.
Private Attributes
FaultCategory	m_category
String	m_namespace_uri
String	m_code
String	m_detail
FaultDetail	m_any_detail
FaultSource	m_source
FaultCompletionStatus	m_completion_status
String	m_description
String	m_server_id
bool	m_is_detail_set
Static Private Attributes
static const QName	m_qname
static const QName	m_category_qname
static const QName	m_namespace_uri_qname
static const QName	m_code_qname
static const QName	m_detail_qname
static const QName	m_source_qname
static const QName	m_completion_status_qname
static const QName	m_description_qname
static const QName	m_server_id_qname

---

Member Function Documentation

virtual void IT_Bus::FaultException::read_contents

(

ComplexTypeReader &

reader

)

throw ((DeserializationException)) [virtual]

Read the member values into the instance.

Derived subclasses implement this method.

Implements IT_Bus::SequenceComplexType.

virtual void IT_Bus::FaultException::write_contents

(

ComplexTypeWriter &

writer

)

const throw ((SerializationException)) [virtual]

Write the member values of the instance.

Derived subclasses implement this method.

Implements IT_Bus::SequenceComplexType.

virtual const QName& IT_Bus::FaultException::get_type

(

)

const [virtual]

Returns the IT_Bus::QName for the type.

Derived subclasses implement this method and return their QName.

Returns:

IT_Bus::QName.

Implements IT_Bus::AnyType.

virtual AnyType& IT_Bus::FaultException::copy

(

const AnyType &

assign

)

[virtual]

Returns a reference to an AnyType that is a copy of the AnyType parameter.

Derived classes override this method, providing an appropriate implementation. In this base class, this method is not supported; an exception is always thrown.

Parameters:

AnyType

to be copied.

Returns:

A reference to AnyType.

Exceptions:

IT_Bus::Exception

with message "Copy not supported"

Reimplemented from IT_Bus::AnyType.

const FaultCategory& IT_Bus::FaultException::get_category

(

)

const

Get the category of the fault.

Returns:

const FaultCategory enum value

FaultCategory& IT_Bus::FaultException::get_category

(

)

Get the category of the fault.

Returns:

FaultCategory enum value

void IT_Bus::FaultException::set_category

(

const FaultCategory &

val

)

Set the category of the fault.

Parameters:

FaultCategory

for this FaultException

const String& IT_Bus::FaultException::get_namespace_uri

(

)

const

Get the namespace of the originator of the fault.

Returns:

const String of namespace for plugin that raised fault

String& IT_Bus::FaultException::get_namespace_uri

(

)

Get the namespace of the originator of the fault.

Returns:

String of namespace for plugin that raised fault

void IT_Bus::FaultException::set_namespace_uri

(

const String &

val

)

Set the namespace of the originator of the fault.

Parameters:

String

of namespace for plugin that raised fault

const FaultSource& IT_Bus::FaultException::get_source

(

)

const

Get the source of the Fault.

Values could be CLIENT, SERVER or UNKNOWN

Returns:

const FaultSource enum value of source

FaultSource& IT_Bus::FaultException::get_source

(

)

Get the source of the Fault Values could be CLIENT, SERVER or UNKNOWN.

Returns:

FaultSource enum value of source

void IT_Bus::FaultException::set_source

(

const FaultSource &

val

)

Set the source of the Fault Values could be CLIENT, SERVER or UNKNOWN.

Parameters:

FaultSource

enum value of source

const FaultCompletionStatus& IT_Bus::FaultException::get_completion_status

(

)

const

Get the completion status of operation when fault was raised.

Values can be YES, NO or MAYBE

Returns:

const FaultCompletionStatus

FaultCompletionStatus& IT_Bus::FaultException::get_completion_status

(

)

Get the completion status of operation when fault was raised.

Values can be YES, NO or MAYBE

Returns:

FaultCompletionStatus

void IT_Bus::FaultException::set_completion_status

(

const FaultCompletionStatus &

val

)

Set the completion status of operation when fault was raised.

Values can be YES, NO or MAYBE

Parameters:

FaultCompletionStatus

const String& IT_Bus::FaultException::get_description

(

)

const

Get the human readable description of the fault.

Returns:

const String for description of fault

String& IT_Bus::FaultException::get_description

(

)

Get the human readable description of the fault.

Returns:

String for description of fault

void IT_Bus::FaultException::set_description

(

const String &

val

)

Set the human readable description of the fault.

Parameters:

const

String for description of fault

---