UpdateResponse Class Reference

SearchResultSet contains the API that is used to handle the response to the RETS SEARCH transaciton. More...

#include <librets/UpdateResponse.h>

Inheritance diagram for UpdateResponse:

RetsObject

List of all members.

Public Member Functions

 UpdateResponse ()
 Default constructor.
virtual ~UpdateResponse ()
const StringVector GetColumns ()
 Returns the column names.
EncodingType GetEncoding ()
 Get the current value for the data encoding flag.
std::string GetErrorFieldName ()
 Get the field name of the current error.
int GetErrorNumber ()
 Get the error number for the current error.
int GetErrorOffset ()
 Get the offset of the error.
std::string GetErrorText ()
 Get the text associated with the error.
int GetReplyCode ()
 Returns the RETS-STATUS ReplyCode.
std::string GetReplyText ()
 Returns the RETS-STATUS ReplyText.
std::string GetString (int columnIndex)
 Returns the value of a column as a string.
std::string GetString (std::string columnName)
 Returns the value of a column as a string.
std::string GetWarningFieldName ()
 Get the field name of the current warning.
int GetWarningNumber ()
 Get the error number for the current warning.
int GetWarningOffset ()
 Get the offset of the warning.
int GetWarningResponseRequired ()
 Get the response required indicator.
std::string GetWarningText ()
 Get the text associated with the warning.
bool HasNext ()
 Returns true if there are more results.
bool HasNextError ()
 Returns true if there are more results.
bool HasNextWarning ()
 Returns true if there are more results.
void Parse (istreamPtr inputStream)
 Parse the result sent back from the client.
void SetEncoding (EncodingType encoding)
 Set the data encoding flag to allow for parsing of extended characters by Expat.
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

SearchResultSet contains the API that is used to handle the response to the RETS SEARCH transaciton.

Constructor & Destructor Documentation

UpdateResponse (  ) 

Default constructor.

virtual ~UpdateResponse (  )  [virtual]


Member Function Documentation

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

const StringVector GetColumns (  ) 

Returns the column names.

Returns:
A string vector containing the column names

EncodingType GetEncoding (  ) 

Get the current value for the data encoding flag.

Returns:
string value of encoding flag.

std::string GetErrorFieldName (  ) 

Get the field name of the current error.

Returns:
string value of the field system name.

int GetErrorNumber (  ) 

Get the error number for the current error.

Returns:
int value of the error.

int GetErrorOffset (  ) 

Get the offset of the error.

Returns:
int containing the offset of the error if known. 0 indicates unknown.

std::string GetErrorText (  ) 

Get the text associated with the error.

Returns:
string containing the error text.

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 GetString ( std::string  columnName  ) 

Returns the value of a column as a string.

Parameters:
columnName column name
Returns:
string value of column

std::string GetString ( int  columnIndex  ) 

Returns the value of a column as a string.

Parameters:
columnIndex column index
Returns:
string value of column

std::string GetWarningFieldName (  ) 

Get the field name of the current warning.

Returns:
string value of the field system name.

int GetWarningNumber (  ) 

Get the error number for the current warning.

Returns:
int value of the warning.

int GetWarningOffset (  ) 

Get the offset of the warning.

Returns:
int containing the offset of the warning if known. 0 indicates unknown.

int GetWarningResponseRequired (  ) 

Get the response required indicator.

Returns:
int containing the value of the response required field.

std::string GetWarningText (  ) 

Get the text associated with the warning.

Returns:
string containing the warning text.

bool HasNext (  ) 

Returns true if there are more results.

This may block waiting for data from the RETS server.

HasNext() has the side effect of incrementing the result set to the next result. After an update, this must be called before you can access the first result row.

Returns:
If there is a next item or not.

bool HasNextError (  ) 

Returns true if there are more results.

This may block waiting for data from the RETS server.

HasNext() has the side effect of incrementing the result set to the next result. After an update, this must be called before you can access the first result row.

Returns:
If there is a next item or not.

bool HasNextWarning (  ) 

Returns true if there are more results.

This may block waiting for data from the RETS server.

HasNext() has the side effect of incrementing the result set to the next result. After an update, this must be called before you can access the first result row.

Returns:
If there is a next item or not.

void Parse ( istreamPtr  inputStream  ) 

Parse the result sent back from the client.

Parameters:
inputStream The input stream containing the data 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