IT_Bus::FaultCompletionStatus Class Reference

#include <it_bus/fault_exception.h>

Inheritance diagram for IT_Bus::FaultCompletionStatus:

List of all members.

---

Detailed Description

Class representing the completion status of the operation that was in progress when the fault occured.

This gives the application the information needed to know if the operation needs to be retried.

The completion status could be YES, NO or MAYBE

Definition at line 206 of file fault_exception.h.

Public Types
enum	CompletionStatus
Public Member Functions
virtual void	write_value (AnySimpleTypeWriter &writer) const throw ((SerializationException))
	Write the instance value.
virtual void	read_value (AnySimpleTypeReader &reader) throw ((DeserializationException))
	Read the value into the instance.
virtual const QName &	get_type () const
	Returns the IT_Bus::QName for the type.
FaultCompletionStatus &	operator= (const FaultCompletionStatus &rhs)
virtual AnyType &	copy (const AnyType &assign)
	Returns a reference to an AnyType that is a copy of the AnyType parameter.
void	set_value (const CompletionStatus value)
	Set the enum value for the completion status.
CompletionStatus	get_value () const
	Get the enum value for the completion status.
Private Attributes
CompletionStatus	m_val
Static Private Attributes
static const QName	m_type

---

Member Function Documentation

virtual void IT_Bus::FaultCompletionStatus::write_value

(

AnySimpleTypeWriter &

writer

)

const throw ((SerializationException)) [virtual]

Write the instance value.

Derived classes implement this method.

Implements IT_Bus::AnySimpleType.

virtual void IT_Bus::FaultCompletionStatus::read_value

(

AnySimpleTypeReader &

reader

)

throw ((DeserializationException)) [virtual]

Read the value into the instance.

Derived classes implement this method.

Implements IT_Bus::AnySimpleType.

virtual const QName& IT_Bus::FaultCompletionStatus::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::FaultCompletionStatus::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.

void IT_Bus::FaultCompletionStatus::set_value

(

const CompletionStatus

value

)

Set the enum value for the completion status.

Parameters:

const

CompletionStatus enum value

CompletionStatus IT_Bus::FaultCompletionStatus::get_value

(

)

const

Get the enum value for the completion status.

Returns:

CompletionStatus enum value

---