#include <librets/ObjectDescriptor.h>
Public Member Functions | |
ObjectDescriptor () | |
Default constructor. | |
std::string | GetObjectKey () const |
Returns the object key for this object. | |
void | SetObjectKey (std::string objectKey) |
Sets the object key for this object. | |
int | GetObjectId () const |
Returns the object ID for this object. | |
void | SetObjectId (int objectId) |
Sets the object ID for this object. | |
std::string | GetDescription () const |
Returns the description of this object. | |
void | SetDescription (std::string description) |
Sets the description of this object. | |
std::string | GetLocationUrl () const |
Returns the location URL for this object. | |
void | SetLocationUrl (std::string locationUrl) |
Sets the location URL for this object. | |
std::string | GetContentType () const |
Returns the MIME content type of this object, for example, "image/jpeg". | |
void | SetContentType (std::string contentType) |
Sets the MIME content type of this object. | |
istreamPtr | GetDataStream () |
Returns an input stream to the object data. | |
void | SetDataStream (istreamPtr dataStream) |
Sets the input stream to the object data. | |
BinaryDataAPtr | GetData () |
Returns all the object data as a class by reading the input stream until EOF is reached. | |
int | GetRetsReplyCode () const |
Returns an integer representing the RETS Response Code for this object. | |
void | SetRetsReplyCode (int retsResponse) |
Sets the RETS Response Code for this object. | |
std::string | GetRetsReplyText () const |
Returns a string representing the RETS Reply Text. | |
void | SetRetsReplyText (std::string replyText) |
Sets the RETS Reply Text. | |
bool | GetWildIndicator () const |
Returns a boolean indicating whether or not the original object ID was an asterisk. | |
void | SetWildIndicator (bool wild) |
Indicates that the Object ID was originally "*";. | |
virtual std::ostream & | Print (std::ostream &outputStream) const |
std::string | ToString () const |
virtual bool | Equals (const RetsObject *object) const |
ObjectDescriptor | ( | ) |
Default constructor.
virtual bool Equals | ( | const RetsObject * | object | ) | const [virtual, inherited] |
std::string GetContentType | ( | ) | const |
Returns the MIME content type of this object, for example, "image/jpeg".
BinaryDataAPtr GetData | ( | ) |
Returns all the object data as a class by reading the input stream until EOF is reached.
The returned object is not owned by the ObjectDescriptor and must be deleted after use. This method is not of much use to native C++ users, but aids in providing wrappers to other language bindings.
istreamPtr GetDataStream | ( | ) |
Returns an input stream to the object data.
This object is owned by this ObjectDescriptor and does not need to be deleted.
std::string GetDescription | ( | ) | const |
Returns the description of this object.
If no description was provided by the server, an empty string will be returned.
std::string GetLocationUrl | ( | ) | const |
Returns the location URL for this object.
This returns a non-empty string if and only if location URLs were requested and the server provides location URLs. A server is not requered to provide location URLs, even if it was requested.
int GetObjectId | ( | ) | const |
Returns the object ID for this object.
std::string GetObjectKey | ( | ) | const |
Returns the object key for this object.
It should match one of the resource entities in the request.
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.
bool GetWildIndicator | ( | ) | const |
Returns a boolean indicating whether or not the original object ID was an asterisk.
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 SetContentType | ( | std::string | contentType | ) |
Sets the MIME content type of this object.
contentType | A MIME content type |
void SetDataStream | ( | istreamPtr | dataStream | ) |
Sets the input stream to the object data.
dataStream | A shared pointer to an input stream |
void SetDescription | ( | std::string | description | ) |
Sets the description of this object.
description | A description |
void SetLocationUrl | ( | std::string | locationUrl | ) |
Sets the location URL for this object.
locationUrl | A location URL |
void SetObjectId | ( | int | objectId | ) |
Sets the object ID for this object.
objectId | An object ID |
void SetObjectKey | ( | std::string | objectKey | ) |
Sets the object key for this object.
objectKey | An object key |
void SetRetsReplyCode | ( | int | retsResponse | ) |
Sets the RETS Response Code for this object.
retsResponse | The RETS Response Code. |
void SetRetsReplyText | ( | std::string | replyText | ) |
Sets the RETS Reply Text.
replyText | The RETS Reply Text. |
void SetWildIndicator | ( | bool | wild | ) |
Indicates that the Object ID was originally "*";.
std::string ToString | ( | ) | const [inherited] |