CapabilityUrls Class Reference

CapabilityUrls contains the API that allows access to the URLs sent in response to the RETS LOGIN transaction. More...

#include <librets/CapabilityUrls.h>

Inheritance diagram for CapabilityUrls:

RetsObject

List of all members.

Public Member Functions

 CapabilityUrls (std::string baseUrl)
 Construct and specify the base URL for the RETS server.
virtual ~CapabilityUrls ()
void SetActionUrl (std::string actionUrl)
 (Internal) Set the RETS "ACTION" URL.
std::string GetActionUrl () const
 Get the RETS "ACTION" URL.
void SetChangePasswordUrl (std::string changePasswordUrl)
 (Internal) Set the RETS "CHANGE PASSWORD" URL.
std::string GetChangePasswordUrl () const
 Get the RETS "CHANGE PASSWORD" URL.
void SetGetObjectUrl (std::string getObjectUrl)
 (Internal) Set the RETS "GET OBJECT" URL.
std::string GetGetObjectUrl () const
 Get the RETS "GET OBJECT" URL.
void SetLoginUrl (std::string loginUrl)
 (Internal) Set the RETS "LOGIN" URL.
std::string GetLoginUrl () const
 Get the RETS "LOGIN" URL.
void SetLoginCompleteUrl (std::string loginCompleteUrl)
 (Internal) Set the RETS "LOGIN COMPLETE" URL.
std::string GetLoginCompleteUrl () const
 Get the RETS "LOGIN COMPLETE" URL.
void SetLogoutUrl (std::string logoutUrl)
 (Internal) Set the RETS "LOGOUT" URL.
std::string GetLogoutUrl () const
 Get the RETS "LOGOUT" URL.
void SetSearchUrl (std::string searchUrl)
 (Internal) Set the RETS "SEARCH" URL.
std::string GetSearchUrl () const
 Get the RETS "SEARCH" URL.
void SetGetMetadataUrl (std::string getMetadataUrl)
 (Internal) Set the RETS "METADATA" URL.
std::string GetGetMetadataUrl () const
 Get the RETS "METADATA" URL.
void SetServerInformationUrl (std::string serverInformationUrl)
 (Internal) Set the RETS "SERVER INFORMATION" URL.
std::string GetServerInformationUrl () const
 Get the RETS "SERVER INFORMATION" URL.
void SetUpdateUrl (std::string updateUrl)
 (Internal) Set the RETS "UPDATE" URL.
std::string GetUpdateUrl () const
 Get the RETS "UPDATE" URL.
virtual std::ostream & Print (std::ostream &outputStream) const
 Prints the object in a standard form for debugging and error reporting.
virtual bool Equals (const RetsObject *object) const
 Checks to see if the URLs are identical between two CapabilityUrls objects.
std::string ToString () const


Detailed Description

CapabilityUrls contains the API that allows access to the URLs sent in response to the RETS LOGIN transaction.

These URLs are then used by the client code to invoke various RETS operations.


Constructor & Destructor Documentation

CapabilityUrls ( std::string  baseUrl  ) 

Construct and specify the base URL for the RETS server.

Parameters:
baseUrl A string containing the base URL for the RETS server.

virtual ~CapabilityUrls (  )  [virtual]


Member Function Documentation

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

Checks to see if the URLs are identical between two CapabilityUrls objects.

Returns:
TRUE if the URLs all match.

Reimplemented from RetsObject.

std::string GetActionUrl (  )  const

Get the RETS "ACTION" URL.

Returns:
A string containing the URL or an empty string if none exists.

std::string GetChangePasswordUrl (  )  const

Get the RETS "CHANGE PASSWORD" URL.

Returns:
A string containing the URL for the RETS ChangePassword transaction. This may be the empty string if none exists.

std::string GetGetMetadataUrl (  )  const

Get the RETS "METADATA" URL.

Returns:
A string containing the URL for the RETS GetMetadata transaction.

std::string GetGetObjectUrl (  )  const

Get the RETS "GET OBJECT" URL.

Returns:
A string containing the URL for the RETS GetObject tarnsaction. This may be the empty string if none exists.

std::string GetLoginCompleteUrl (  )  const

Get the RETS "LOGIN COMPLETE" URL.

Returns:
A string containing the URL for the RETS Login Complete operation. Note that this is currently a reserved operation.

std::string GetLoginUrl (  )  const

Get the RETS "LOGIN" URL.

Returns:
A string containing the URL for the RETS Login transaction.

std::string GetLogoutUrl (  )  const

Get the RETS "LOGOUT" URL.

Returns:
A string containing the URL for the RETS Logout transaction.

std::string GetSearchUrl (  )  const

Get the RETS "SEARCH" URL.

Returns:
A string containing the URL for the RETS Search transaction.

std::string GetServerInformationUrl (  )  const

Get the RETS "SERVER INFORMATION" URL.

This is for RETS 1.7 and later and will return an empty string if it is not implemented.

Returns:
A string containing the URL for the RETS ServerInformation transaction. It will be an empty string if not supported.

std::string GetUpdateUrl (  )  const

Get the RETS "UPDATE" URL.

Returns:
A string containing the URL for the RETS Update transaction. It will be an empty string if not supported.

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

Prints the object in a standard form for debugging and error reporting.

Reimplemented from RetsObject.

void SetActionUrl ( std::string  actionUrl  ) 

(Internal) Set the RETS "ACTION" URL.

Parameters:
actionUrl A string containing the URL for the ACTION operation.

void SetChangePasswordUrl ( std::string  changePasswordUrl  ) 

(Internal) Set the RETS "CHANGE PASSWORD" URL.

Parameters:
changePasswordUrl A string containing the URL for the RETS ChangePassword transaction.

void SetGetMetadataUrl ( std::string  getMetadataUrl  ) 

(Internal) Set the RETS "METADATA" URL.

Parameters:
getMetadataUrl A string containing the URL for the RETS GetMetadata transaction.

void SetGetObjectUrl ( std::string  getObjectUrl  ) 

(Internal) Set the RETS "GET OBJECT" URL.

Parameters:
getObjectUrl A string containing the URL for the RETS GetObject transaction.

void SetLoginCompleteUrl ( std::string  loginCompleteUrl  ) 

(Internal) Set the RETS "LOGIN COMPLETE" URL.

Parameters:
loginCompleteUrl A string containing the URL for hte RETS Login Complete operation.

void SetLoginUrl ( std::string  loginUrl  ) 

(Internal) Set the RETS "LOGIN" URL.

Parameters:
loginUrl A string containing the URL for the RETS Login transaction.

void SetLogoutUrl ( std::string  logoutUrl  ) 

(Internal) Set the RETS "LOGOUT" URL.

Parameters:
logoutUrl A string containing the URL for the RETS Logout transaction.

void SetSearchUrl ( std::string  searchUrl  ) 

(Internal) Set the RETS "SEARCH" URL.

Parameters:
searchUrl A string containing the URL for the RETS Search transaction.

void SetServerInformationUrl ( std::string  serverInformationUrl  ) 

(Internal) Set the RETS "SERVER INFORMATION" URL.

This is for RETS 1.7 and later.

Parameters:
serverInformationUrl A string containing the URL for the RETS ServerInformation transaction.

void SetUpdateUrl ( std::string  updateUrl  ) 

(Internal) Set the RETS "UPDATE" URL.

Parameters:
updateUrl A string containing the URL for the RETS Update transaction.

std::string ToString (  )  const [inherited]


Generated by  doxygen