RetsException Class Reference

RetsException is the base class for all libRETS exceptions. More...

#include <librets/RetsException.h>

Inheritance diagram for RetsException:

RetsHttpException RetsReplyException RetsSqlException RetsUnknownMetadataException

List of all members.

Public Member Functions

 RetsException (std::string message)
 Creates a new exception with a message string.
 RetsException (std::string message, std::string extendedMessage)
 Create a new exception that includes extended message information.
virtual ~RetsException () throw ()
virtual std::string GetName () const throw ()
void SetContext (const RetsExceptionContext &context)
RetsExceptionContext GetContext () const throw ()
virtual std::string GetMessage () const throw ()
 Returns the error message.
virtual std::string GetExtendedMessage () const throw ()
 Return the extended error message.
virtual void PrintContextMessage (std::ostream &outputStream) const throw ()
std::string GetContextMessage () const throw ()
virtual void PrintFullReport (std::ostream &outputStream) const throw ()
std::string GetFullReport () const throw ()
virtual const char * what () const throw ()
 Returns the error message as a C-style character string.


Detailed Description

RetsException is the base class for all libRETS exceptions.

Constructor & Destructor Documentation

RetsException ( std::string  message  ) 

Creates a new exception with a message string.

Parameters:
message Exception message

RetsException ( std::string  message,
std::string  extendedMessage 
)

Create a new exception that includes extended message information.

Parameters:
message Exception message
extendedMessage Extended message

virtual ~RetsException (  )  throw () [virtual]


Member Function Documentation

RetsExceptionContext GetContext (  )  const throw ()

std::string GetContextMessage (  )  const throw ()

virtual std::string GetExtendedMessage (  )  const throw () [virtual]

Return the extended error message.

Returns:
The extended merror message.

std::string GetFullReport (  )  const throw ()

virtual std::string GetMessage (  )  const throw () [virtual]

Returns the error message.

Returns:
The error message

Reimplemented in RetsHttpException.

virtual std::string GetName (  )  const throw () [virtual]

virtual void PrintContextMessage ( std::ostream &  outputStream  )  const throw () [virtual]

virtual void PrintFullReport ( std::ostream &  outputStream  )  const throw () [virtual]

void SetContext ( const RetsExceptionContext context  ) 

virtual const char* what (  )  const throw () [virtual]

Returns the error message as a C-style character string.

Returns:
The C-style error message


Generated by  doxygen