KD SOAP API Documentation 2.2
|
#include <KDSoapFaultException.h>
Public Member Functions | |
KDSoapFaultException () | |
KDSoapFaultException (const KDSoapFaultException &cpy) | |
KDSoapFaultException (const QString &faultCode, const QString &faultString, const QString &faultActor=QString()) | |
~KDSoapFaultException () | |
void | deserialize (const KDSoapValue &mainValue) |
KDSoapValue | detailValue () const |
QString | faultActor () const |
QString | faultCode () const |
QString | faultString () const |
KDSoapFaultException & | operator= (const KDSoapFaultException &other) |
void | setDetailValue (const KDSoapValue &detailValue) |
void | setFaultActor (const QString &faultActor) |
void | setFaultCode (const QString &faultCode) |
void | setFaultString (const QString &faultString) |
Static Public Member Functions | |
static const KDSoapValue & | faultDetails (const KDSoapValue &faultValue) |
KDSoapFaultException is the base class for exceptions representing a fault element. So far supporting only SOAP 1.1 version which mean the following attributes : <faultcode>, <faultstring>, <faultfactor>, <detail>
The <detail> tag optionally contains specific serialized fault information. represented as an exception in the client side.
Definition at line 25 of file KDSoapFaultException.h.
KDSoapFaultException::KDSoapFaultException | ( | ) |
Constructor
Definition at line 29 of file KDSoapFaultException.cpp.
KDSoapFaultException::KDSoapFaultException | ( | const KDSoapFaultException & | cpy | ) |
Copy constructor
Definition at line 34 of file KDSoapFaultException.cpp.
KDSoapFaultException::KDSoapFaultException | ( | const QString & | faultCode, |
const QString & | faultString, | ||
const QString & | faultActor = QString() |
||
) |
Constructs a KDSoapFaultException according to the SOAP 1.1 attriutes.
faultCode | a code for identifying the fault |
faultString | a human readable explanation of the fault |
faultActor | information about who caused the fault to happen |
Definition at line 39 of file KDSoapFaultException.cpp.
References faultActor(), faultCode(), and faultString().
KDSoapFaultException::~KDSoapFaultException | ( | ) |
Destructor
Definition at line 57 of file KDSoapFaultException.cpp.
void KDSoapFaultException::deserialize | ( | const KDSoapValue & | mainValue | ) |
Reconstructs the KDSoapFaultException object from a KDSoapValue.
mainValue | KDSoapValue represents the fault tag element |
Definition at line 61 of file KDSoapFaultException.cpp.
References QList::at(), KDSoapValue::childValues(), QList::count(), KDSoapValue::name(), KDSoapValue::value(), and QVariant::value().
KDSoapValue KDSoapFaultException::detailValue | ( | ) | const |
Returns the <detail> tag of the fault element as a KDSoapValue. When the fault is generic, return an empty KDSoapValue. When the fault is specific the KDSoapValue optionally contains specific serialized fault information.
Definition at line 123 of file KDSoapFaultException.cpp.
Referenced by setDetailValue().
QString KDSoapFaultException::faultActor | ( | ) | const |
Returns the fault actor of the fault as a QString
Definition at line 113 of file KDSoapFaultException.cpp.
Referenced by KDSoapFaultException(), and setFaultActor().
QString KDSoapFaultException::faultCode | ( | ) | const |
Returns the fault code.
Definition at line 78 of file KDSoapFaultException.cpp.
Referenced by KDSoapFaultException(), and setFaultCode().
|
static |
Returns the KDSoapValue representing the <detail> tag from the parameter.
faultValue | Represent the <fault> tag in the SOAP protocol |
Definition at line 83 of file KDSoapFaultException.cpp.
References QList::at(), KDSoapValue::childValues(), QList::count(), and KDSoapValue::name().
QString KDSoapFaultException::faultString | ( | ) | const |
Returns the human readable fault string of the fault.
Definition at line 103 of file KDSoapFaultException.cpp.
Referenced by KDSoapFaultException(), and setFaultString().
KDSoapFaultException & KDSoapFaultException::operator= | ( | const KDSoapFaultException & | other | ) |
Assignment operator
Definition at line 47 of file KDSoapFaultException.cpp.
void KDSoapFaultException::setDetailValue | ( | const KDSoapValue & | detailValue | ) |
Set the KDSoapValue of the fault.
detailValue | KDSoapValue representing the <detail> tag of a fault message |
Definition at line 128 of file KDSoapFaultException.cpp.
References detailValue().
void KDSoapFaultException::setFaultActor | ( | const QString & | faultActor | ) |
Set the fault actor with a string.
faultActor | information about who caused the fault to happen |
Definition at line 118 of file KDSoapFaultException.cpp.
References faultActor().
void KDSoapFaultException::setFaultCode | ( | const QString & | faultCode | ) |
Set the code of the fault.
faultCode | Code of the fault |
Definition at line 99 of file KDSoapFaultException.cpp.
References faultCode().
void KDSoapFaultException::setFaultString | ( | const QString & | faultString | ) |
Set the human-readable QString of the fault.
faultString | Human-readable message |
Definition at line 108 of file KDSoapFaultException.cpp.
References faultString().