Classes | |
| class | BinaryData |
| A helper class that wraps binary data. More... | |
| class | CapabilityUrls |
| CapabilityUrls contains the API that allows access to the URLs sent in response to the RETS LOGIN transaction. More... | |
| class | GetObjectRequest |
| A GetObjectRequest represents the parameters needed to perform a RETS GetObject transaction. More... | |
| class | GetObjectResponse |
| A GetObjectResponse represents a response from a RETS GetObject transaction. More... | |
| class | LoginResponse |
| LoginResponse contains the API that allows access to the information sent in response to a successful RETS LOGIN transaction. More... | |
| class | LogoutResponse |
| LogoutResponse contains the API that allows access to the information sent in response to a successful RETS LOGOUT transaction. More... | |
| class | MetadataClass |
| MetadataClass is an implementation of MetadataElement that represents Class information for the metadata. More... | |
| class | MetadataEditMask |
| MetadataEditMask is an implementation of MetadataElement that represents Edit mask metadata. More... | |
| class | MetadataElement |
| MetadataElement is the fundamental class that represents an element of metadata. More... | |
| class | MetadataForeignKey |
| MetadataForeignKey is an implementation of MetadataElement that represents Foreign Key information for the metadata. More... | |
| class | MetadataLookup |
| MetadataLookup is an implementation of MetadataElement that represents Lookup metadata. More... | |
| class | MetadataLookupType |
| MetadataLookupType is an implementation of MetadataElement that represents Lookup Type metadata. More... | |
| class | MetadataObject |
| MetadataObject is an implementation of MetadataElement that represents Object metadata. More... | |
| class | MetadataResource |
| MetadataResource is an implementation of MetadataElement that represents Resource metadata. More... | |
| class | MetadataSearchHelp |
| MetadataSearchHelp is an implementation of MetadataElement that represents Search help metadata. More... | |
| class | MetadataSystem |
| MetadataSystem is an implementation of MetadataElement that represents System metadata. More... | |
| class | MetadataTable |
| MetadataTable is an implementation of MetadataElement that represents Table metadata. More... | |
| class | MetadataUpdate |
| MetadataUpdate is an implementation of MetadataElement that represents Update metadata. More... | |
| class | MetadataUpdateHelp |
| MetadataUpdateHelp is an implementation of MetadataElement that represents Update Help metadata. More... | |
| class | MetadataUpdateType |
| MetadataUpdateType is an implementation of MetadataElement that represents Update Type metadata. More... | |
| class | MetadataValidationExpression |
| MetadataValidationExpression is an implementation of MetadataElement that represents Validation Expression metadata. More... | |
| class | MetadataValidationExternal |
| MetadataValidationExternal is an implementation of MetadataElement that represents Validation External metadata. More... | |
| class | MetadataValidationExternalType |
| MetadataValidationExternalType is an implementation of MetadataElement that represents Validation External Type metadata. More... | |
| class | MetadataValidationLookup |
| MetadataValidationLookup is an implementation of MetadataElement that represents Validation Lookup metadata. More... | |
| class | MetadataValidationLookupType |
| MetadataValidationLookupType is an implementation of MetadataElement that represents Validation Lookup Type metadata. More... | |
| class | ObjectDescriptor |
| An ObjectDescriptor represents a single object retrieved from a GetObject transaction. More... | |
| class | RetsErrorHandler |
| RetsErrorHandler is an error handling interface that can be used by users to set error handling policy. More... | |
| class | NullErrorHandler |
| An implementation of RetsErrorHandler that just silently ignores all errors. More... | |
| class | RetsException |
| RetsException is the base class for all libRETS exceptions. More... | |
| class | RetsHttpException |
| RetsHttpException is an implementation of RetsException that is thrown when an Http transport error is seen. More... | |
| class | RetsMetadata |
| RetsMetadata contains the API that is the main interface to all of the metadata. More... | |
| class | RetsReplyException |
| RetsReplyException is an implementation of RetsException that is thrown when the RETS REPLY-CODE is non-zero. More... | |
| class | RetsSession |
| RetsSession contains the API that is the main controlling interface to the RETS server. More... | |
| class | RetsSqlException |
| RetsSqlException is an implementation of RetsException that is thrown for errors in the Sql to Dmql parser. More... | |
| class | RetsUnknownMetadataException |
| RetsReplyException is an implementation of RetsException that is thrown when the RETS REPLY-CODE is non-zero. More... | |
| class | SearchRequest |
| SearchRequest contains the API that is used to set up and customer a RETS SEARCH transaciton. More... | |
| class | SearchResultSet |
| SearchResultSet contains the API that is used to handle the response to the RETS SEARCH transaciton. More... | |
| class | ServerInformationRequest |
| ServerInformationRequest is the API that allows access to the RETS 1.7 SERVERINFORMATION transaction. More... | |
| class | ServerInformationResponse |
| ServerInformationResponse is the API that allows access to the RETS 1.7 SERVERINFORMATION transaction results. More... | |
| class | UpdateRequest |
| UpdateRequest contains the API that is used to set up and customer a RETS UPDATE transaciton. More... | |
| class | UpdateResponse |
| SearchResultSet contains the API that is used to handle the response to the RETS SEARCH transaciton. More... | |
Typedefs | |
| typedef std::auto_ptr< BinaryData > | BinaryDataAPtr |
| typedef std::vector < MetadataElementPtr > | MetadataElementList |
| A vector of MetadataElement objects. | |
| typedef boost::shared_ptr < MetadataElementList > | MetadataElementListPtr |
| A smart pointer to MetadataElementList. | |
| typedef std::vector < MetadataValidationExternalTypePtr > | MetadataValidationExternalTypeList |
| A vector of MetadataValidationExternal objects. | |
| typedef boost::shared_ptr < MetadataValidationExternalTypeList > | MetadataValidationExternalTypeListPtr |
| A smart pointer to MetadataValidationExternalTypeList. | |
| typedef std::vector < MetadataValidationLookupTypePtr > | MetadataValidationLookupTypeList |
| A vector of MetadataValidationLookupType objects. | |
| typedef boost::shared_ptr < MetadataValidationLookupTypeList > | MetadataValidationLookupTypeListPtr |
| A smart pointer to MetadataValidationLookupTypeList. | |
| typedef std::vector < MetadataResource * > | MetadataResourceList |
| A vector of MetadataResource objects. | |
| typedef boost::shared_ptr < MetadataResourceList > | MetadataResourceListPtr |
| A smart pointer to MetadataResourceList. | |
| typedef std::vector < MetadataClass * > | MetadataClassList |
| A vector of MetadataClass objects. | |
| typedef boost::shared_ptr < MetadataClassList > | MetadataClassListPtr |
| A smart pointer to MetadataClassList. | |
| typedef std::vector < MetadataTable * > | MetadataTableList |
| A vector of MetadataTables objects. | |
| typedef boost::shared_ptr < MetadataTableList > | MetadataTableListPtr |
| A smart pointer to MetadataTableList. | |
| typedef std::vector < MetadataLookup * > | MetadataLookupList |
| A vector of MetadataLookup objects. | |
| typedef std::vector < MetadataLookupType * > | MetadataLookupTypeList |
| A vector of MetadataLookupType objects. | |
| typedef std::vector < MetadataObject * > | MetadataObjectList |
| A vector of MetadataObject objects. | |
| typedef std::vector < MetadataForeignKey * > | MetadataForeignKeyList |
| A vector of MetadataForeignKeys objects. | |
| typedef boost::shared_ptr < MetadataForeignKeyList > | MetadataForeignKeyListPtr |
| A smart pointer to MetadataForeignKeyList. | |
Enumerations | |
| enum | EncodingType { RETS_XML_DEFAULT_ENCODING, RETS_XML_ISO_ENCODING, RETS_XML_UTF8_ENCODING } |
| EncodingType contains the definitions of which type of parsing the XML parser will perform. More... | |
| enum | RetsVersion { RETS_1_0, RETS_1_5, RETS_1_7, RETS_1_7_2 } |
| RetsVersion contains the definitions of types the various protocol versions of RETS servers. More... | |
| enum | UserAgentAuthType { USER_AGENT_AUTH_RETS_1_7, USER_AGENT_AUTH_INTEREALTY } |
See RetsSession.
| typedef std::auto_ptr<BinaryData> BinaryDataAPtr |
| typedef std::vector<MetadataClass *> MetadataClassList |
A vector of MetadataClass objects.
| typedef boost::shared_ptr<MetadataClassList> MetadataClassListPtr |
A smart pointer to MetadataClassList.
| typedef std::vector<MetadataElementPtr> MetadataElementList |
A vector of MetadataElement objects.
| typedef boost::shared_ptr<MetadataElementList> MetadataElementListPtr |
A smart pointer to MetadataElementList.
| typedef std::vector<MetadataForeignKey *> MetadataForeignKeyList |
A vector of MetadataForeignKeys objects.
| typedef boost::shared_ptr<MetadataForeignKeyList> MetadataForeignKeyListPtr |
A smart pointer to MetadataForeignKeyList.
| typedef std::vector<MetadataLookup *> MetadataLookupList |
A vector of MetadataLookup objects.
| typedef std::vector<MetadataLookupType *> MetadataLookupTypeList |
A vector of MetadataLookupType objects.
| typedef std::vector<MetadataObject *> MetadataObjectList |
A vector of MetadataObject objects.
| typedef std::vector<MetadataResource *> MetadataResourceList |
A vector of MetadataResource objects.
| typedef boost::shared_ptr<MetadataResourceList> MetadataResourceListPtr |
A smart pointer to MetadataResourceList.
| typedef std::vector<MetadataTable *> MetadataTableList |
A vector of MetadataTables objects.
| typedef boost::shared_ptr<MetadataTableList> MetadataTableListPtr |
A smart pointer to MetadataTableList.
| typedef std::vector<MetadataValidationExternalTypePtr> MetadataValidationExternalTypeList |
A vector of MetadataValidationExternal objects.
| typedef boost::shared_ptr<MetadataValidationExternalTypeList> MetadataValidationExternalTypeListPtr |
A smart pointer to MetadataValidationExternalTypeList.
| typedef std::vector<MetadataValidationLookupTypePtr> MetadataValidationLookupTypeList |
A vector of MetadataValidationLookupType objects.
| typedef boost::shared_ptr<MetadataValidationLookupTypeList> MetadataValidationLookupTypeListPtr |
A smart pointer to MetadataValidationLookupTypeList.
| enum EncodingType |
EncodingType contains the definitions of which type of parsing the XML parser will perform.
Note that the RETS standard is supposed to be US-ASCII, but there are non-compliant servers that provide data with ISO or UNICODE values that will cause the XML parsing to fail. In those instances, use RETS_XML_ISO_ENCODING or RETS_XML_UTF8_ENCODING to tell the parser to handle those characters.
| enum RetsVersion |
| enum UserAgentAuthType |