ServerInformationResponse Class Reference

ServerInformationResponse is the API that allows access to the RETS 1.7 SERVERINFORMATION transaction results. More...

#include <librets/ServerInfoResponse.h>

Inheritance diagram for ServerInformationResponse:

RetsObject

List of all members.

Public Member Functions

 ServerInformationResponse ()
 Default constructor.
virtual ~ServerInformationResponse ()
void Parse (istreamPtr inputStream)
 Parse the Server Information Response.
const StringVector GetParameters ()
 Returns the parameter names.
std::string GetResource (std::string parameterName)
 Returns the resource name of a parameter as a string.
std::string GetClass (std::string parameterName)
 Returns the class name of a parameter as a string.
std::string GetValue (std::string parameterName)
 Returns the value of a parameter as a string.
void SetEncoding (EncodingType encoding)
 Set the data encoding flag to allow for parsing of extended characters by Expat.
EncodingType GetEncoding ()
 Get the current value for the data encoding flag.
int GetReplyCode ()
 Returns the RETS-STATUS ReplyCode.
std::string GetReplyText ()
 Returns the RETS-STATUS ReplyText.
void SetInputStream (istreamPtr inputStream)
 Set the input stream for Parse.
virtual std::ostream & Print (std::ostream &outputStream) const
std::string ToString () const
virtual bool Equals (const RetsObject *object) const


Detailed Description

ServerInformationResponse is the API that allows access to the RETS 1.7 SERVERINFORMATION transaction results.

Constructor & Destructor Documentation

Default constructor.

virtual ~ServerInformationResponse (  )  [virtual]


Member Function Documentation

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

std::string GetClass ( std::string  parameterName  ) 

Returns the class name of a parameter as a string.

Parameters:
parameterName parameter name
Returns:
string value of class name

EncodingType GetEncoding (  ) 

Get the current value for the data encoding flag.

Returns:
string value of encoding flag.

const StringVector GetParameters (  ) 

Returns the parameter names.

Returns:
The parameter names

int GetReplyCode (  ) 

Returns the RETS-STATUS ReplyCode.

Returns:
int value of ReplyCode

std::string GetReplyText (  ) 

Returns the RETS-STATUS ReplyText.

Returns:
string value of ReplyText.

std::string GetResource ( std::string  parameterName  ) 

Returns the resource name of a parameter as a string.

Parameters:
parameterName parameter name
Returns:
string value of resource name

std::string GetValue ( std::string  parameterName  ) 

Returns the value of a parameter as a string.

Parameters:
parameterName parameter name
Returns:
string value of parameter

void Parse ( istreamPtr  inputStream  ) 

Parse the Server Information Response.

Parameters:
inputStream The stream containing the response to be parsed.
Exceptions:
RetsReplyException 

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

void SetEncoding ( EncodingType  encoding  ) 

Set the data encoding flag to allow for parsing of extended characters by Expat.

RETS is officially US-ASCII, but this will allow a work around for servers that haven't properly sanitized their data.

Parameters:
encoding Either RETS_XML_DEFAULT_ENCODING, RETS_XML_ISO_ENCODING or RETS_XML_UTF8_ENCODING.

void SetInputStream ( istreamPtr  inputStream  ) 

Set the input stream for Parse.

Parameters:
inputStream Input Stream

std::string ToString (  )  const [inherited]


Generated by  doxygen