<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libmusicbrainz3: MusicBrainz::ReleaseFilter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespace_music_brainz.html">MusicBrainz</a> </li>
<li><a class="el" href="class_music_brainz_1_1_release_filter.html">MusicBrainz::ReleaseFilter</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>MusicBrainz::ReleaseFilter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="MusicBrainz::ReleaseFilter" --><!-- doxytag: inherits="MusicBrainz::IFilter" -->
<p>A filter for the release collection.
<a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for MusicBrainz::ReleaseFilter:</div>
<div class="dyncontent">
<div class="center">
<img src="class_music_brainz_1_1_release_filter.png" usemap="#MusicBrainz::ReleaseFilter_map" alt=""/>
<map id="MusicBrainz::ReleaseFilter_map" name="MusicBrainz::ReleaseFilter_map">
<area href="class_music_brainz_1_1_i_filter.html" alt="MusicBrainz::IFilter" shape="rect" coords="0,0,162,24"/>
</map>
</div>
<p><a href="class_music_brainz_1_1_release_filter-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_filter.html#aebe36401cb0590825829ba942858a56b">title</a> (const std::string &value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_filter.html#a00527af336484e9dfbf718f1ddd65749">discId</a> (const std::string &value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_filter.html#a29d4f7b22e4f3b5f6a79e73e45880283">releaseType</a> (const std::string &value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_filter.html#a42046bd3b772ad16b7dc463085f07ed0">artistName</a> (const std::string &value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_filter.html#a9975c71ab6a0a0325547ca5549137caa">artistId</a> (const std::string &value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_filter.html#ade81f6bc774d40acfa522bbba496cfe0">limit</a> (const int value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_filter.html#a54a9258fc7b2a1cf48b3c86a54d3783e">query</a> (const std::string &query)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_i_filter.html#aaba1f8574aef404c9df93d340f10d611">ParameterList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_filter.html#a505a23ca0d2844341b019eba5695a761">createParameters</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a map of query parameters. <a href="#a505a23ca0d2844341b019eba5695a761"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A filter for the release collection. </p>
<p>If <em>discId</em> or <em>artistId</em> are set, only releases matching those IDs are returned. The <em>releaseType</em> parameter allows to limit the types of the releases returned. You can set it to <a class="el" href="class_music_brainz_1_1_release.html#ae808d68a9e1b6b8fc4c48b8b60f5263b">Release::TYPE_ALBUM</a> and <a class="el" href="class_music_brainz_1_1_release.html#a192cd411547a7f453aca4bbc8d274ad9">Release::TYPE_OFFICIAL</a>, for example, to only get officially released albums. Note that those values are connected using the <em>AND</em> operator. MusicBrainz' support is currently very limited, so <a class="el" href="class_music_brainz_1_1_release.html#af8be10709f53684bd83d231b565d0fa2">Release::TYPE_LIVE</a> and <a class="el" href="class_music_brainz_1_1_release.html#a48891d65d03da2eccf04322f997ee77b">Release::TYPE_COMPILATION</a> exclude each other (see <a href="http://wiki.musicbrainz.org/AlbumAttribute">the documentation on release attributes </a>) for more information and all valid values).</p>
<p>If both the <em>artistName</em> and the <em>artistId</em> parameter are given, the server will ignore <em>artistName</em>.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The original Python library has <em>releaseTypes</em> parameter that accepts a list of release types. Due to C++ limitations, the library has <em>releaseType</em> parameter instead, that accepts only one release type, but you can use it multiple times. For example, to convert Python code: <div class="fragment"><pre class="fragment"> ReleaseFilter(releaseTypes=(Release.TYPE_ALBUM, Release.TYPE_OFFICIAL))
</pre></div> you can use following C++ code: <div class="fragment"><pre class="fragment"> ReleaseFilter().releaseType(<a class="code" href="class_music_brainz_1_1_release.html#ae808d68a9e1b6b8fc4c48b8b60f5263b">Release::TYPE_ALBUM</a>).releaseType(<a class="code" href="class_music_brainz_1_1_release.html#a192cd411547a7f453aca4bbc8d274ad9">Release::TYPE_OFFICIAL</a>)
</pre></div> </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9975c71ab6a0a0325547ca5549137caa"></a><!-- doxytag: member="MusicBrainz::ReleaseFilter::artistId" ref="a9975c71ab6a0a0325547ca5549137caa" args="(const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a>& MusicBrainz::ReleaseFilter::artistId </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a42046bd3b772ad16b7dc463085f07ed0"></a><!-- doxytag: member="MusicBrainz::ReleaseFilter::artistName" ref="a42046bd3b772ad16b7dc463085f07ed0" args="(const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a>& MusicBrainz::ReleaseFilter::artistName </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a505a23ca0d2844341b019eba5695a761"></a><!-- doxytag: member="MusicBrainz::ReleaseFilter::createParameters" ref="a505a23ca0d2844341b019eba5695a761" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_music_brainz_1_1_i_filter.html#aaba1f8574aef404c9df93d340f10d611">ParameterList</a> MusicBrainz::ReleaseFilter::createParameters </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a map of query parameters. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>: a string->string map of parameters </dd></dl>
<p>Implements <a class="el" href="class_music_brainz_1_1_i_filter.html#a00640c633304bf278acc71766f9e87e9">MusicBrainz::IFilter</a>.</p>
</div>
</div>
<a class="anchor" id="a00527af336484e9dfbf718f1ddd65749"></a><!-- doxytag: member="MusicBrainz::ReleaseFilter::discId" ref="a00527af336484e9dfbf718f1ddd65749" args="(const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a>& MusicBrainz::ReleaseFilter::discId </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ade81f6bc774d40acfa522bbba496cfe0"></a><!-- doxytag: member="MusicBrainz::ReleaseFilter::limit" ref="ade81f6bc774d40acfa522bbba496cfe0" args="(const int value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a>& MusicBrainz::ReleaseFilter::limit </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a54a9258fc7b2a1cf48b3c86a54d3783e"></a><!-- doxytag: member="MusicBrainz::ReleaseFilter::query" ref="a54a9258fc7b2a1cf48b3c86a54d3783e" args="(const std::string &query)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a>& MusicBrainz::ReleaseFilter::query </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>query</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a29d4f7b22e4f3b5f6a79e73e45880283"></a><!-- doxytag: member="MusicBrainz::ReleaseFilter::releaseType" ref="a29d4f7b22e4f3b5f6a79e73e45880283" args="(const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a>& MusicBrainz::ReleaseFilter::releaseType </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aebe36401cb0590825829ba942858a56b"></a><!-- doxytag: member="MusicBrainz::ReleaseFilter::title" ref="aebe36401cb0590825829ba942858a56b" args="(const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_music_brainz_1_1_release_filter.html">ReleaseFilter</a>& MusicBrainz::ReleaseFilter::title </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
