TV-Browser 2.7.5 API

devplugin
Interface ProgramRatingIf


public interface ProgramRatingIf

This Interface makes it possible for plugins to offer rating infos to other plugins

Since:
2.7

Method Summary
 Icon getIcon()
          Icon for this interface that is displayed by other plugins
 Icon getIconForProgram(Program p)
          Get Icon for the rating.
 String getName()
          Name for this interface that is displayed by other plugins
 int getRatingForProgram(Program p)
          Returns a rating for this program.
 boolean hasDetailsDialog()
          Has this plugin a dialog that displays details about this rating?
 void showDetailsFor(Program p)
          shows a detail dialog for a rating
 

Method Detail

getName

String getName()
Name for this interface that is displayed by other plugins

Returns:
Name

getIcon

Icon getIcon()
Icon for this interface that is displayed by other plugins

Returns:
Icon

getRatingForProgram

int getRatingForProgram(Program p)
Returns a rating for this program. The rating must be between 0 and 100, -1 if no rating is available

Parameters:
p - program to get rating for
Returns:
rating for the program (between 0 and 100), -1 if no rating is available

getIconForProgram

Icon getIconForProgram(Program p)
Get Icon for the rating. This gives plugins the opportunity to show it's icon for the specific rating

Parameters:
p - program to get icon for
Returns:
icon for rating, null if no rating is available

hasDetailsDialog

boolean hasDetailsDialog()
Has this plugin a dialog that displays details about this rating?

Returns:
true if the plugin is able to show details of the rating

showDetailsFor

void showDetailsFor(Program p)
shows a detail dialog for a rating

Parameters:
p - show dialog for this program

TV-Browser 2.7.5 API

TV-Browser 2.7.5, Copyright (C) 04-2003 Martin Oberhauser (martin@tvbrowser.org)