magoffin.matt.ma2.plugin
Interface BrowseModePlugin

All Superinterfaces:

Plugin

All Known Implementing Classes:

AbstractJdbcBrowseModePlugin, AlbumsByDateBrowseModePlugin, PopularityBrowseModePlugin, RatingAverageBrowseModePlugin

public interface BrowseModePlugin
extends Plugin

Plugin API for browse-mode types.

A "browse mode" is a mode of browsing all shared albums or items of a single user. It implements some query that can geneate a browse search results object.

Version:

$Revision: 50 $ $Date: 2007-11-08 11:58:47 +1300 (Thu, 08 Nov 2007) $

Author:

matt

Method Summary

SearchResults	find(BrowseAlbumsCommand command, PaginationCriteria pagination) Perform the search, returning SearchResults populated with AlbumSearchResult objects.
java.lang.String[]	getSupportedModes() Get the supported modes of this plugin.
boolean	supportsMode(java.lang.String mode) Test if this plugin supports a given browse mode.

Methods inherited from interface magoffin.matt.ma2.plugin.Plugin

getMessageResourceNames, getPluginType, initialize

Method Detail

supportsMode

boolean supportsMode(java.lang.String mode)

Test if this plugin supports a given browse mode.

Parameters:

mode - the mode to test

Returns:

boolean

find

SearchResults find(BrowseAlbumsCommand command,
                   PaginationCriteria pagination)

Perform the search, returning SearchResults populated with AlbumSearchResult objects.

Parameters:

command - the browse command

pagination - the pagination criteria

Returns:

the search results

getSupportedModes

java.lang.String[] getSupportedModes()

Get the supported modes of this plugin.

Returns:

the supported modes