/usr/include/musicbrainz3/iwebservice.h is in libmusicbrainz3-dev 3.0.2-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | /*
* MusicBrainz -- The Internet music metadatabase
*
* Copyright (C) 2006 Lukas Lalinsky
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* $Id: iwebservice.h 8466 2006-09-05 08:59:44Z luks $
*/
#ifndef __MUSICBRAINZ3_IWEBSERVICE_H__
#define __MUSICBRAINZ3_IWEBSERVICE_H__
#include <string>
#include <musicbrainz3/musicbrainz.h>
#include <musicbrainz3/includes.h>
#include <musicbrainz3/filters.h>
namespace MusicBrainz
{
/**
* An interface all concrete web service classes have to implement.
*
* All web service classes have to implement this and follow the
* method specifications.
*/
class MB_API IWebService
{
public:
virtual ~IWebService() {};
/**
* Query the web service.
*
* Using this method, you can either get a resource by id (using
* the \a id parameter, or perform a query on all resources of
* a type.
*
* The \a filter and the \a id parameter exclude each other. If
* you are using a filter, you may not set \a 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.
*
* @param entity a string containing the entity's name
* @param id a string containing a UUID, or the empty string
* @param include a tuple containing values for the 'inc' parameter
* @param filter parameters, depending on the entity
* @param version a string containing the web service version to use
*
* @return a string contaning the returned data
*
* @throw WebServiceError: in case of errors
*/
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;
/**
* Submit data to the web service.
*
* @param entity a string containing the entity's name
* @param id a string containing a UUID, or the empty string
* @param data a string containing the data to post
* @param version a string containing the web service version to use
*
* @throw WebServiceError in case of errors
*/
virtual void post(const std::string &entity,
const std::string &id,
const std::string &data,
const std::string &version = "1") = 0;
};
}
#endif
|