#include <librets/GetObjectResponse.h>
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. | |
ObjectDescriptor * | NextObject () |
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 |
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.
Default constructor.
virtual ~GetObjectResponse | ( | ) | [virtual] |
virtual bool Equals | ( | const RetsObject * | object | ) | const [virtual, inherited] |
std::string GetErrorText | ( | ) |
Returns any optional additional error codes for the http transaction.
int GetHttpResponse | ( | ) |
Returns the http response code.
ObjectDescriptor* NextObject | ( | ) |
Returns the next object found in the response.
void Parse | ( | RetsHttpResponsePtr | httpResponse, | |
bool | ignoreMalformedHeaders = false | |||
) |
(Internal) Parse the response from the server into one or more objects.
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] |
Reimplemented in CapabilityUrls, DefaultMetadataCollector, DmqlQuery, FieldCriterion, GetObjectQuery, JunctionCriterion, LiteralCriterion, LookupCriterion, MetadataElement, NotCriterion, RetsXmlAttribute, RetsXmlEndDocumentEvent, RetsXmlEndElementEvent, RetsXmlStartElementEvent, RetsXmlTextEvent, and Uri.
void SetDefaultObjectKeyAndId | ( | std::string | defaultObjectKey, | |
int | defaultObjectId | |||
) |
(Internal) Set the default object key and object ID.
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.
responseCode | An integer containing the http response code. | |
errorText | A string containing option error text. |
std::string ToString | ( | ) | const [inherited] |