This class encapsulates an error or success message. More...

Inheritance diagram for CAXMLErrorMessage:

Public Member Functions
	CAXMLErrorMessage (const UINT32 errorCode, UINT8 *message)
	Creates an errorMessage object. More...

	CAXMLErrorMessage (UINT32 errorCode)
	Uses a default description String. More...

	CAXMLErrorMessage (const UINT32 errorCode, UINT8 message, CAAbstractXMLEncodable messageObject)
	attaches an object to the error message More...

	CAXMLErrorMessage (UINT8 *strXmlData)
	Parses the string XML representation. More...

	CAXMLErrorMessage (DOMElement *elemRoot)

	~CAXMLErrorMessage ()

SINT32	toXmlElement (XERCES_CPP_NAMESPACE::DOMDocument a_doc, DOMElement &elemRoot)
	Creates the XML structure inside an existing DOM_Document, but does not append it to any node. More...

UINT32	getErrorCode ()

UINT8 *	getDescription ()

void *	getMessageObject ()

Public Member Functions inherited from CAAbstractXMLEncodable
	CAAbstractXMLEncodable ()

virtual	~CAAbstractXMLEncodable ()
	pure virtual destructor. More...

SINT32	toXmlDocument (XERCES_CPP_NAMESPACE::DOMDocument *&pDoc)
	returns a pointer to the tagname of this XML structure's top level element. More...

UINT8 *	toXmlString (UINT32 *pSize)
	Converts the XML structure to a null-terminated C-String representation. More...

Static Public Attributes
static const UINT32	ERR_OK = 0

static const UINT32	ERR_INTERNAL_SERVER_ERROR = 1

static const UINT32	ERR_WRONG_FORMAT = 2

static const UINT32	ERR_WRONG_DATA = 3

static const UINT32	ERR_KEY_NOT_FOUND = 4

static const UINT32	ERR_BAD_SIGNATURE = 5

static const UINT32	ERR_BAD_REQUEST = 6

static const UINT32	ERR_NO_ACCOUNTCERT = 7

static const UINT32	ERR_NO_BALANCE = 8

static const UINT32	ERR_NO_CONFIRMATION = 9

static const UINT32	ERR_ACCOUNT_EMPTY = 10

static const UINT32	ERR_CASCADE_LENGTH = 11

static const UINT32	ERR_DATABASE_ERROR = 12

static const UINT32	ERR_INSUFFICIENT_BALANCE = 13

static const UINT32	ERR_NO_FLATRATE_OFFERED = 14

static const UINT32	ERR_INVALID_CODE = 15

static const UINT32	ERR_OUTDATED_CC = 16

static const UINT32	ERR_INVALID_PRICE_CERT = 17

static const UINT32	ERR_MULTIPLE_LOGIN = 18

static const UINT32	ERR_NO_RECORD_FOUND = 19

static const UINT32	ERR_SUCCESS_BUT_WITH_ERRORS = 20

static const UINT32	ERR_BLOCKED = 21

static const UINT32	ERR_NO_ERROR_GIVEN = 100

Private Member Functions
SINT32	setValues (DOMElement *elemRoot)

Private Attributes
UINT32	m_iErrorCode

UINT8 *	m_strErrMsg

void *	m_messageObject

Detailed Description

This class encapsulates an error or success message.

In order to be independent from the HTTP protocol on the higher layer, this is now used instead of http errorcodes.

Author: Bastian Voigt, Elmar Schraml

Constructor & Destructor Documentation

◆ CAXMLErrorMessage() [1/5]

CAXMLErrorMessage::CAXMLErrorMessage	(	const UINT32	errorCode,
		UINT8 *	message
	)

Creates an errorMessage object.

The errorcode should be one of the above ERR_* constants.

Parameters

errorCode	UINT32 one of the above constants
message	String a human-readable description of the error

References m_iErrorCode, m_messageObject, and m_strErrMsg.

◆ CAXMLErrorMessage() [2/5]

CAXMLErrorMessage::CAXMLErrorMessage ( UINT32 errorCode )

Uses a default description String.

Parameters

errorCode UINT32

References m_iErrorCode, m_messageObject, and m_strErrMsg.

◆ CAXMLErrorMessage() [3/5]

CAXMLErrorMessage::CAXMLErrorMessage	(	const UINT32	errorCode,
		UINT8 *	message,
		CAAbstractXMLEncodable *	messageObject
	)

attaches an object to the error message

References m_iErrorCode, m_messageObject, and m_strErrMsg.

◆ CAXMLErrorMessage() [4/5]

CAXMLErrorMessage::CAXMLErrorMessage ( UINT8 * strXmlData )

Parses the string XML representation.

References E_SUCCESS, ERR_NO_ERROR_GIVEN, m_iErrorCode, m_messageObject, m_strErrMsg, parseDOMDocument(), and setValues().

◆ CAXMLErrorMessage() [5/5]

CAXMLErrorMessage::CAXMLErrorMessage ( DOMElement * elemRoot )

References E_SUCCESS, ERR_NO_ERROR_GIVEN, m_iErrorCode, m_messageObject, m_strErrMsg, and setValues().

◆ ~CAXMLErrorMessage()

CAXMLErrorMessage::~CAXMLErrorMessage ( )

References m_messageObject, and m_strErrMsg.

Member Function Documentation

◆ getDescription()

UINT8* CAXMLErrorMessage::getDescription ( )

References m_strErrMsg.

Referenced by CAAccountingInstance::__handleSettleResult(), and CAAccountingInstance::settlementTransaction().

◆ getErrorCode()

UINT32 CAXMLErrorMessage::getErrorCode ( )

References m_iErrorCode.

Referenced by CAAccountingInstance::__handleSettleResult(), and CAAccountingInstance::settlementTransaction().

◆ getMessageObject()

void* CAXMLErrorMessage::getMessageObject ( )

References m_messageObject.

Referenced by CAAccountingInstance::__handleSettleResult(), and CAAccountingInstance::settlementTransaction().

◆ setValues()

SINT32 CAXMLErrorMessage::setValues ( DOMElement * elemRoot )

private

References DOM_Output::dumpToMem(), DOM_Output::dumpToString(), E_SUCCESS, ERR_ACCOUNT_EMPTY, ERR_OUTDATED_CC, getDOMChildByName(), getDOMElementAttribute(), getDOMElementValue(), len, m_iErrorCode, m_messageObject, m_strErrMsg, and CAMsg::printMsg().

Referenced by CAXMLErrorMessage().

◆ toXmlElement()

SINT32 CAXMLErrorMessage::toXmlElement	(	XERCES_CPP_NAMESPACE::DOMDocument *	a_pDoc,
		DOMElement *&	pElemRoot
	)

virtual

Creates the XML structure inside an existing DOM_Document, but does not append it to any node.

Parameters

a_doc	an existing DOM_Document
elemRoot	on return contains the root element of the created XML structure. Note that the element is not appended to any node in the document

Implements CAAbstractXMLEncodable.

References createDOMElement(), E_SUCCESS, m_iErrorCode, m_messageObject, m_strErrMsg, setDOMElementAttribute(), setDOMElementValue(), CAAbstractXMLEncodable::toXmlElement(), and XML_ELEMENT_ERROR_MSG.