RetsReplyException Class Reference

RetsReplyException is an implementation of RetsException that is thrown when the RETS REPLY-CODE is non-zero. More...

#include <librets/RetsReplyException.h>

Inheritance diagram for RetsReplyException:

RetsException

List of all members.

Public Member Functions

 RetsReplyException (int replyCode, std::string meaning)
 Construct the exception with the reply code and meaning.
 RetsReplyException (int replyCode, std::string meaning, std::string extendedMeaning)
 Construct the exception with the reply code, meaning and extended meaning.
virtual ~RetsReplyException () throw ()
int GetReplyCode () const throw ()
 Return the RETS REPLY-CODE for this exception.
std::string GetMeaning () const throw ()
 Return the meaning associate with the reply code.
std::string GetExtendedMeaning () const throw ()
 Return any extended meaning associated with this reply code.
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

RetsReplyException is an implementation of RetsException that is thrown when the RETS REPLY-CODE is non-zero.

Constructor & Destructor Documentation

RetsReplyException ( int  replyCode,
std::string  meaning 
)

Construct the exception with the reply code and meaning.

Parameters:
replyCode The RETS REPLY-CODE sent with the transaction.
meaning A string containing the meaning of the reply code.

RetsReplyException ( int  replyCode,
std::string  meaning,
std::string  extendedMeaning 
)

Construct the exception with the reply code, meaning and extended meaning.

Parameters:
replyCode The RETS REPLY-CODE sent with the transaction.
meaning A string containing the meaning of the reply code.
extendedMeaning A string containing optional additional text qualifying the exception.

virtual ~RetsReplyException (  )  throw () [virtual]


Member Function Documentation

RetsExceptionContext GetContext (  )  const throw () [inherited]

std::string GetContextMessage (  )  const throw () [inherited]

std::string GetExtendedMeaning (  )  const throw ()

Return any extended meaning associated with this reply code.

Returns:
A string containing the extended meaning. This will be an empty string if no extended meaning exists.

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

Return the extended error message.

Returns:
The extended merror message.

std::string GetFullReport (  )  const throw () [inherited]

std::string GetMeaning (  )  const throw ()

Return the meaning associate with the reply code.

Returns:
A string containing the meaning associated with the reply code.

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

Returns the error message.

Returns:
The error message

Reimplemented in RetsHttpException.

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

int GetReplyCode (  )  const throw ()

Return the RETS REPLY-CODE for this exception.

Returns:
An integer representation of the reply code.

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

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

void SetContext ( const RetsExceptionContext context  )  [inherited]

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

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

Returns:
The C-style error message


Generated by  doxygen