LogoutResponse Class Reference

LogoutResponse contains the API that allows access to the information sent in response to a successful RETS LOGOUT transaction. More...

#include <librets/LogoutResponse.h>

Inheritance diagram for LogoutResponse:

KeyValueResponse RetsObject

List of all members.

Public Member Functions

std::string GetBillingInfo () const
 Returns billing information given by the server.
std::string GetLogoutMessage () const
 Returns the logout message from the server.
int GetConnectTime () const
 Returns the number of seconds connected.
void Parse (istreamPtr inputStream, RetsVersion retsVersion)
 Parse the input stream, converting the data into keys and values.
void Parse (istreamPtr inputStream, RetsVersion retsVersion, EncodingType encoding)
 Parse the input stream, converting the data into keys and values.
std::string GetValue (std::string key) const
 For a given key, return the associated value.
int GetRetsReplyCode () const
 Returns an integer representing the RETS Response Code for this object.
std::string GetRetsReplyText () const
 Returns a string representing the RETS Reply Text.
virtual std::ostream & Print (std::ostream &outputStream) const
std::string ToString () const
virtual bool Equals (const RetsObject *object) const

Protected Member Functions

RetsXmlTextEventPtr GetBodyEventFromStandardResponse (RetsXmlEventListPtr eventList)
RetsXmlTextEventPtr GetBodyEventFromResponseWithNoRetsResponse (RetsXmlEventListPtr eventList)
RetsXmlTextEventPtr GetBodyEventFromShortResponse (RetsXmlEventListPtr eventList)

Static Protected Member Functions

static void AssertEquals (const std::string &expected, const std::string &actual)
static void AssertEquals (int expected, int actual)
static void AssertEventListSize (int expected, RetsXmlEventListPtr eventList)
static void AssertNotEquals (const std::string &expected, const std::string &actual)


Detailed Description

LogoutResponse contains the API that allows access to the information sent in response to a successful RETS LOGOUT transaction.

Member Function Documentation

static void AssertEquals ( int  expected,
int  actual 
) [static, protected, inherited]

static void AssertEquals ( const std::string &  expected,
const std::string &  actual 
) [static, protected, inherited]

static void AssertEventListSize ( int  expected,
RetsXmlEventListPtr  eventList 
) [static, protected, inherited]

static void AssertNotEquals ( const std::string &  expected,
const std::string &  actual 
) [static, protected, inherited]

virtual bool Equals ( const RetsObject object  )  const [virtual, inherited]

std::string GetBillingInfo (  )  const

Returns billing information given by the server.

Returns:
A string containing the Billing informaiton

RetsXmlTextEventPtr GetBodyEventFromResponseWithNoRetsResponse ( RetsXmlEventListPtr  eventList  )  [protected, inherited]

RetsXmlTextEventPtr GetBodyEventFromShortResponse ( RetsXmlEventListPtr  eventList  )  [protected, inherited]

RetsXmlTextEventPtr GetBodyEventFromStandardResponse ( RetsXmlEventListPtr  eventList  )  [protected, inherited]

int GetConnectTime (  )  const

Returns the number of seconds connected.

Returns:
An integer representing the number of seconds connected

std::string GetLogoutMessage (  )  const

Returns the logout message from the server.

Returns:
A string containing the logout message

int GetRetsReplyCode (  )  const [inherited]

Returns an integer representing the RETS Response Code for this object.

This is really only used internally to indicate login failures on those servers that don't return a 401 Unauthorized response but do return the RETS Response Code.

Returns:
An integer containing the RETS Response Code.

std::string GetRetsReplyText (  )  const [inherited]

Returns a string representing the RETS Reply Text.

Returns:
A string containing the RETS Reply Text.

std::string GetValue ( std::string  key  )  const [inherited]

For a given key, return the associated value.

If the key is not found and empty string is returned.

Parameters:
key A string representing the key whose value is to be returned.
Returns:
A string containing the value.

void Parse ( istreamPtr  inputStream,
RetsVersion  retsVersion,
EncodingType  encoding 
) [inherited]

Parse the input stream, converting the data into keys and values.

Parameters:
inputStream A pointer to the input stream.
retsVersion The RETS version.
encoding The character encoding to use when parsing.

void Parse ( istreamPtr  inputStream,
RetsVersion  retsVersion 
) [inherited]

Parse the input stream, converting the data into keys and values.

Parameters:
inputStream A pointer to the input stream.
retsVersion The RETS version.

virtual std::ostream& Print ( std::ostream &  outputStream  )  const [virtual, inherited]

std::string ToString (  )  const [inherited]


Generated by  doxygen