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

Type IFilter

object --+
         |
        IFilter

Known Subclasses:
ArtistFilter, ReleaseFilter, TrackFilter, UserFilter

A filter for collections.

This is the interface all filters have to implement. Filter classes are initialized with a set of criteria and are then applied to collections of items. The criteria are usually strings or integer values, depending on the filter.

Note that all strings passed to filters should be unicode strings (python type unicode). Standard strings are converted to unicode internally, but have a limitation: Only 7 Bit pure ASCII characters may be used, otherwise a UnicodeDecodeError is raised.
Method Summary
  createParameters(self)
Create a list of query parameters.
    Inherited from object
  __init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  __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

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

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