org.homeunix.thecave.moss.plugin
Interface MossPlugin

All Known Subinterfaces:

MossActionPlugin, MossRunnablePlugin

All Known Implementing Classes:

AdvancedPreferences, AverageIncomeExpenseByCategory, BuddiExportPlugin, BuddiImportPlugin, BuddiPreferencePlugin, BuddiReportPlugin, BuddiRunnablePlugin, BuddiSynchronizePlugin, BuddiTransactionCellRendererPlugin, ChequeTransactionCellRenderer, DefaultTransactionCellRenderer, ExpensesPieGraph, ImportTestData, IncomeExpenseReportByCategory, IncomePieGraph, LocalePreferences, MenuPlugin, NetworkPreferences, NetWorthOverTime, PluginPreferences, SimpleTransactionCellRenderer, ViewPreferences

public interface MossPlugin

Method Summary

java.lang.String	getDescription() Returns the plugin description.
Version	getMaximumVersion() Returns the maximum program version needed to run this plugin.
Version	getMinimumVersion() Returns the minimum program version needed to run this plugin.
java.lang.String	getName() Returns the plugin name.
boolean	isPluginActive() Should this plugin be activated? Most people can just put true here; if there is some logic which determines if this is to be shown or not, though, you can add it here.

Method Detail

getDescription

java.lang.String getDescription()

Returns the plugin description. This may be used in different places, depending on the type of plugin.

Returns:

getName

java.lang.String getName()

Returns the plugin name. This may be used in different places, depending on the type of plugin.

Returns:

getMinimumVersion

Version getMinimumVersion()

Returns the minimum program version needed to run this plugin. If this is null, there is no limitation on the program (not recommended unless you can guarantee that the plugin uses no API calls within the program).

Returns:

The Version object containing the minimum version number.

getMaximumVersion

Version getMaximumVersion()

Returns the maximum program version needed to run this plugin. If this is null, there is no limitation on the program (not recommended unless you can guarantee that the plugin uses no API calls within the program).

Returns:

The Version object containing the maximum version number.

isPluginActive

boolean isPluginActive()

Should this plugin be activated? Most people can just put true here; if there is some logic which determines if this is to be shown or not, though, you can add it here.

Returns: