IT_Bus::FaultException Class Reference

#include <it_bus/fault_exception.h>

Inheritance diagram for IT_Bus::FaultException:

IT_Bus::SequenceComplexType IT_Bus::Exception IT_Bus::ComplexType IT_Bus::AnyType IT_Bus::ObjectBase IT_Bus::ImplementationDetails 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 Exceptionclone () const
 Clone the exception onto the heap.
virtual void rethrow () const
 Rethrow the exception.
virtual void write_contents (ComplexTypeWriter &writer) const IT_THROW_DECL((SerializationException))
 Write the member values of the instance.
virtual const QNameget_type () const
 Returns the IT_Bus::QName for the type.
FaultExceptionoperator= (const FaultException &rhs)
const FaultCategoryget_category () const
 Get the category of the fault.
FaultCategoryget_category ()
 Get the category of the fault.
void set_category (const FaultCategory &val)
 Set the category of the fault.
const Stringget_namespace_uri () const
 Get the namespace of the originator of the fault.
Stringget_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 FaultSourceget_source () const
 Get the source of the Fault.
FaultSourceget_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 FaultCompletionStatusget_completion_status () const
 Get the completion status of operation when fault was raised.
FaultCompletionStatusget_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 Stringget_description () const
 Get the human readable description of the fault.
Stringget_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

FaultCategory& IT_Bus::FaultException::get_category (  ) 

Get the category of the fault.

Returns:
FaultCategory enum value

const FaultCategory& IT_Bus::FaultException::get_category (  )  const

Get the category of the fault.

Returns:
const FaultCategory enum value

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

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

String& IT_Bus::FaultException::get_description (  ) 

Get the human readable description of the fault.

Returns:
String for description of fault

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_namespace_uri (  ) 

Get the namespace of the originator of the fault.

Returns:
String of namespace for plugin that raised fault

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

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

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

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.

void IT_Bus::FaultException::set_category ( const FaultCategory val  ) 

Set the category of the fault.

Parameters:
FaultCategory for this FaultException

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 

void IT_Bus::FaultException::set_description ( const String val  ) 

Set the human readable description of the fault.

Parameters:
const String for description of 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

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

virtual void IT_Bus::FaultException::write_contents ( ComplexTypeWriter writer  )  const [virtual]

Write the member values of the instance.

Derived subclasses implement this method.

Implements IT_Bus::SequenceComplexType.


Generated on Thu Sep 7 11:39:53 2006 for Artix by  doxygen 1.4.7