MusicBrainz::IWebService Class Reference

An interface all concrete web service classes have to implement. More...

Inheritance diagram for MusicBrainz::IWebService:

List of all members.

Public Member Functions
virtual	~IWebService ()
virtual std::string	get (const std::string &entity, const std::string &id, const IIncludes::IncludeList &include, const IFilter::ParameterList &filter, const std::string &version="1")=0
	Query the web service.
virtual void	post (const std::string &entity, const std::string &id, const std::string &data, const std::string &version="1")=0
	Submit data to the web service.

---

Detailed Description

An interface all concrete web service classes have to implement.

All web service classes have to implement this and follow the method specifications.

---

Constructor & Destructor Documentation

virtual MusicBrainz::IWebService::~IWebService

(

)

[inline, virtual]

---

Member Function Documentation

virtual std::string MusicBrainz::IWebService::get	(	const std::string &	entity,
		const std::string &	id,
		const IIncludes::IncludeList &	include,
		const IFilter::ParameterList &	filter,
		const std::string &	version = "1"
	)			[pure virtual]

Query the web service.

Using this method, you can either get a resource by id (using the id parameter, or perform a query on all resources of a type.

The filter and the id parameter exclude each other. If you are using a filter, you may not set id and vice versa.

Returns a file-like object containing the result or raises a WebServiceError or one of its subclasses in case of an error. Which one is used depends on the implementing class.

Parameters:

	entity	a string containing the entity's name
	id	a string containing a UUID, or the empty string
	include	a tuple containing values for the 'inc' parameter
	filter	parameters, depending on the entity
	version	a string containing the web service version to use

Returns:

a string contaning the returned data

Exceptions:

WebServiceError,:

in case of errors

Implemented in MusicBrainz::WebService.

virtual void MusicBrainz::IWebService::post	(	const std::string &	entity,
		const std::string &	id,
		const std::string &	data,
		const std::string &	version = "1"
	)			[pure virtual]

Submit data to the web service.

Parameters:

	entity	a string containing the entity's name
	id	a string containing a UUID, or the empty string
	data	a string containing the data to post
	version	a string containing the web service version to use

Exceptions:

WebServiceError

in case of errors

Implemented in MusicBrainz::WebService.