GetObjectResponse Class Reference

A GetObjectResponse represents a response from a RETS GetObject transaction. More...

#include <librets/GetObjectResponse.h>

Inheritance diagram for GetObjectResponse:

RetsObject

List of all members.

Public Member Functions

 GetObjectResponse ()
 Default constructor.
virtual ~GetObjectResponse ()
void SetDefaultObjectKeyAndId (std::string defaultObjectKey, int defaultObjectId)
 (Internal) Set the default object key and object ID.
void SetHttpResponse (int responseCode, std::string errorText)
 (Internal) Set the http response code.
void Parse (RetsHttpResponsePtr httpResponse, bool ignoreMalformedHeaders=false)
 (Internal) Parse the response from the server into one or more objects.
ObjectDescriptorNextObject ()
 Returns the next object found in the response.
int GetHttpResponse ()
 Returns the http response code.
std::string GetErrorText ()
 Returns any optional additional error codes for the http transaction.
virtual std::ostream & Print (std::ostream &outputStream) const
std::string ToString () const
virtual bool Equals (const RetsObject *object) const


Detailed Description

A GetObjectResponse represents a response from a RETS GetObject transaction.

A response may result in zero or more objects. RETS does not provide a mechanism for getting all objects returned in a response, so a user must retrieve each object in turn, until there are none left.


Constructor & Destructor Documentation

Default constructor.

virtual ~GetObjectResponse (  )  [virtual]


Member Function Documentation

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

std::string GetErrorText (  ) 

Returns any optional additional error codes for the http transaction.

Returns:
A string containing any additional error text.

int GetHttpResponse (  ) 

Returns the http response code.

Returns:
An integer containing the http response code.

ObjectDescriptor* NextObject (  ) 

Returns the next object found in the response.

Returns:
The object descriptor representing an object.

void Parse ( RetsHttpResponsePtr  httpResponse,
bool  ignoreMalformedHeaders = false 
)

(Internal) Parse the response from the server into one or more objects.

Parameters:
httpResponse A pointer to RetsHttpResponse containing the response from the GetObject request.
ignoreMalformedHeaders A boolean that when true indicates to the parser that malformed headers and expected and to ignore them.

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

void SetDefaultObjectKeyAndId ( std::string  defaultObjectKey,
int  defaultObjectId 
)

(Internal) Set the default object key and object ID.

Parameters:
defaultObjectKey A string representing the default object key.
defaultObjectId An integer representing the default object ID.

void SetHttpResponse ( int  responseCode,
std::string  errorText 
)

(Internal) Set the http response code.

Parameters:
responseCode An integer containing the http response code.
errorText A string containing option error text.

std::string ToString (  )  const [inherited]


Generated by  doxygen