Package musicbrainz2 :: Module webservice :: Class ReleaseFilter
[frames | no frames]

Type ReleaseFilter

object --+    
         |    
   IFilter --+
             |
            ReleaseFilter


A filter for the release collection.
Method Summary
  __init__(self, title, discId, releaseTypes, artistName, artistId, limit)
Constructor.
  createParameters(self)
Create a list of query parameters.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Method Details

__init__(self, title=None, discId=None, releaseTypes=None, artistName=None, artistId=None, limit=None)
(Constructor)

Constructor.

If discId or artistId are set, only releases matching those IDs are returned. The releaseTypes parameter allows to limit the types of the releases returned. You can set it to (Release.TYPE_ALBUM, Release.TYPE_OFFICIAL), for example, to only get officially released albums. Note that those values are connected using the AND operator. MusicBrainz' support is currently very limited, so Release.TYPE_LIVE and Release.TYPE_COMPILATION exclude each other (see the documentation on release attributes for more information and all valid values).

If both the artistName and the artistId parameter are given, the server will ignore artistName.
Parameters:
title - a unicode string containing the release's title
discId - a unicode string containing the DiscID
releaseTypes - a sequence of release type URIs
artistName - a unicode string containing the artist's name
artistId - a unicode string containing the artist's ID
limit - the maximum number of releases to return
Overrides:
__builtin__.object.__init__

See Also: the constants in musicbrainz2.model.Release

createParameters(self)

Create a list of query parameters.

This method creates a list of (parameter, value) tuples, based on the contents of the implementing subclass. parameter is a string containing a parameter name and value an arbitrary string. No escaping of those strings is required.
Returns:
a sequence of (key, value) pairs
Overrides:
musicbrainz2.webservice.IFilter.createParameters (inherited documentation)

Generated by Epydoc 2.1 on Wed Dec 20 18:19:28 2006 http://epydoc.sf.net