#include <libppbase/base_soap/SOAPException.h>

Inheritance diagram for base_soap::SOAPException:

Public Types
enum	{ errDOM = 1, errEmptyDocument, errNoParameters, errBadParameterStructure, errNoSuchAttachment, errOutOfMemory, errProtocol, errConfig, errIO, errDB, errBadClass, errMissingInstance, errLockInstance, errBadMethod, errBadArgument, errNoSuchChildNode, errNoSuchParameter, errTypeCast, errInputMissing, errSelectionMissing, errFileMissing, errFileTooSmall, errFileTooLarge, errInvalid, errInvalidChar, errBadLength, errTooShort, errTooLong, errDuplicate, errSigned, errPrecision, errPermissionDenied, errRemote }
	soap error codes More...
Public Member Functions
	SOAPException ()
	Default constructor.
	SOAPException (int errcode, const char *fmt=NULL,...)
	Constructor.
	SOAPException (int errcode, const base::Exception &ex, const char *fmt=NULL,...)
	Constructor that takes a nested exception.
	SOAPException (const base::String &field, int errcode, size_t len=0, size_t min=0, size_t max=0, const base::String &character="", const char *fmt=NULL,...)
	Constructor for a field-related error (missing, invalid, bad length, invalid character...).
virtual	~SOAPException () throw ()
	Destructor.
const char *	getCgiError () const
	Gets the cgi error string.
const base::String &	getChar () const
	Gets the invalid character.
const base::String &	getField () const
	Gets the field name.
size_t	getLength () const
	Gets the field length.
size_t	getMaxLength () const
	Gets the maximum field length.
size_t	getMinLength () const
	Gets the minimum field length.
Static Public Attributes
static const char *	_cgierrors []
	cgi error strings

Detailed Description

SOAP exception.

Author:: Christoph Schwarz

Version:

Id:: SOAPException.h 21 2010-09-05 04:18:17Z cschwarz1

Member Enumeration Documentation

anonymous enum

soap error codes

Enumerator:

errDOM	DOM error occurred.
errEmptyDocument	Document is empty.
errNoParameters	Document does not contain parameters section.
errBadParameterStructure	Parameter has bad/unknown structure.
errNoSuchAttachment	Attachment does not exist.
errOutOfMemory	Out of memory.
errProtocol	RPC protocol error occurred.
errConfig	configuration error
errIO	input/output error
errDB	database error
errBadClass	Bad/unknown class name.
errMissingInstance	Instance argument required.
errLockInstance	Unable to lock instance (timeout?).
errBadMethod	Bad/unknown method name.
errBadArgument	Invalid argument in method call.
errNoSuchChildNode	Requested child node does not exist.
errNoSuchParameter	Parameter does not exist.
errTypeCast	Parameter could not be converted to target data type.
errInputMissing	Mandatory parameter is missing or is empty.
errSelectionMissing	Mandatory parameter is missing or is empty.
errFileMissing	Mandatory input attachment is missing or is empty.
errFileTooSmall	Input attachment is too small.
errFileTooLarge	Input attachment exceeds maximum size.
errInvalid	Invalid parameter value.
errInvalidChar	Invalid character in parameter value.
errBadLength	Parameter value has bad length.
errTooShort	Parameter value is too short.
errTooLong	Parameter value is too long.
errDuplicate	Parameter value caused a primary key violation (duplicate entry).
errSigned	Signed number not allowed.
errPrecision	Too many decimal places.
errPermissionDenied	Permission denied.
errRemote	General remote exception.

Constructor & Destructor Documentation

base_soap::SOAPException::SOAPException	(	int	errcode,
		const char *	fmt = `NULL`,
			...
	)

Constructor.

Parameters:

	errcode	application-defined error code
	fmt	printf-like format string to take an additional error message
	...	additional arguments for the format string

base_soap::SOAPException::SOAPException	(	int	errcode,
		const base::Exception &	ex,
		const char *	fmt = `NULL`,
			...
	)

Constructor that takes a nested exception.

Parameters:

	errcode	the error code
	ex	the nested exception
	fmt	printf-like format string to take an additional error message
	...	additional arguments for the format string

base_soap::SOAPException::SOAPException	(	const base::String &	field,
		int	errcode,
		size_t	len = `0`,
		size_t	min = `0`,
		size_t	max = `0`,
		const base::String &	character = `""`,
		const char *	fmt = `NULL`,
			...
	)

Constructor for a field-related error (missing, invalid, bad length, invalid character...).

Parameters:

	field	the field name
	errcode	the error code
	len	the current (bad) field length
	min	the minimum field length
	max	the maximum field length
	character	the invalid character
	fmt	printf-like format string to take an additional error message
	...	additional arguments for the format string

Member Function Documentation

const char* base_soap::SOAPException::getCgiError ( ) const

Gets the cgi error string.

Returns:: the cgi error string

const base::String& base_soap::SOAPException::getChar ( ) const

Gets the invalid character.

Returns:: the invalid character

const base::String& base_soap::SOAPException::getField ( ) const

Gets the field name.

Returns:: the field name

size_t base_soap::SOAPException::getLength ( ) const

Gets the field length.

Returns:: the field length

size_t base_soap::SOAPException::getMaxLength ( ) const

Gets the maximum field length.

Returns:: the maximum field length

size_t base_soap::SOAPException::getMinLength ( ) const

Gets the minimum field length.

Returns:: the minimum field length

The documentation for this class was generated from the following file:

libppbase/base_soap/SOAPException.h

base_soap::SOAPException Class Reference

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation