com.pmease.quickbuild.pluginsupport
Interface Plugin

All Superinterfaces:
Dependency
All Known Implementing Classes:
AbstractPlugin, AbstractReportPlugin, Quickbuild.DefaultPlugin, ReportEnginePlugin

public interface Plugin
extends Dependency


Method Summary
 java.lang.Object findConfigurationSetting(Configuration configuration, boolean interpolate)
           
 PluginCategory getCategory()
           
 java.lang.String getClasspath()
           
 java.lang.Object getConfigurationSetting(Configuration configuration, boolean interpolate)
           
 java.lang.Class<?> getConfigurationSettingClass()
           
 org.apache.wicket.markup.html.panel.Panel getConfigurationSettingPanel(java.lang.String panelId)
           
 java.lang.Object[] getExtensions()
           
 java.lang.Object getGroupSetting(Group group, boolean interpolate)
           
 java.lang.Class<?> getGroupSettingClass()
           
 java.lang.String getId()
          Get identifier of the dependent object.
 java.lang.String getName()
           
 java.lang.Object getSetting(boolean interpolate)
           
 java.lang.Class<?> getSettingClass()
           
 AbstractPluginSettingEditPage getSettingEditPage()
           
 java.lang.Object getUserSetting(User user, boolean interpolate)
           
 java.lang.Class<?> getUserSettingClass()
           
 java.lang.String getVendor()
           
 java.lang.String getVersion()
           
 boolean isEnabled()
           
 void saveConfigurationSetting(Configuration configuration, java.lang.Object pluginSetting)
           
 void saveGroupSetting(Group group, java.lang.Object pluginSetting)
           
 void saveSetting(java.lang.Object pluginSetting)
           
 void saveUserSetting(User user, java.lang.Object pluginSetting)
           
 void setEnabled(boolean enabled)
           
 void settingChanged()
           
 void start(BundleContext context)
           
 void statusChanged()
           
 void stop(BundleContext context)
           
 
Methods inherited from interface com.pmease.quickbuild.util.Dependency
getDependencyIds
 

Method Detail

getId

java.lang.String getId()
Description copied from interface: Dependency
Get identifier of the dependent object.

Specified by:
getId in interface Dependency
Returns:

getName

java.lang.String getName()

getVendor

java.lang.String getVendor()

getVersion

java.lang.String getVersion()

setEnabled

void setEnabled(boolean enabled)

isEnabled

boolean isEnabled()

getSettingClass

java.lang.Class<?> getSettingClass()
Returns:
null if this plugin does not have global plugin setting.

getGroupSettingClass

java.lang.Class<?> getGroupSettingClass()
Returns:
null if this plugin does not have group level plugin setting.

getUserSettingClass

java.lang.Class<?> getUserSettingClass()
Returns:
null if this plugin does not have user level plugin setting.

getConfigurationSettingClass

java.lang.Class<?> getConfigurationSettingClass()
Returns:
null if this plugin does not need configuration level plugin setting.

saveSetting

void saveSetting(java.lang.Object pluginSetting)
Save global plugin setting.


saveConfigurationSetting

void saveConfigurationSetting(Configuration configuration,
                              java.lang.Object pluginSetting)
Save plugin setting of specified configuration.


saveUserSetting

void saveUserSetting(User user,
                     java.lang.Object pluginSetting)
Save plugin setting of specified user.


saveGroupSetting

void saveGroupSetting(Group group,
                      java.lang.Object pluginSetting)
Save plugin setting of specified group.


getSetting

java.lang.Object getSetting(boolean interpolate)
Get global plugin setting. The param determines whether or not to interpolate the setting. Return null if not defined.


getUserSetting

java.lang.Object getUserSetting(User user,
                                boolean interpolate)
Get plugin setting of specified user. The second param determines whether or not to interpolate the setting. Return null if not defined.


getGroupSetting

java.lang.Object getGroupSetting(Group group,
                                 boolean interpolate)
Get plugin setting of specified group. The second param determines whether or not to interpolate the setting. Return null if not defined.


getConfigurationSetting

java.lang.Object getConfigurationSetting(Configuration configuration,
                                         boolean interpolate)
Get plugin setting of specified configuration. The second param determines whether or not to interpolate the setting. Return null if not defined.


findConfigurationSetting

java.lang.Object findConfigurationSetting(Configuration configuration,
                                          boolean interpolate)
Find plugin setting of specified configuration with inheritance considered. The second param determines whether or not to interpolate the setting. Return null if not defined.


getExtensions

java.lang.Object[] getExtensions()

getSettingEditPage

AbstractPluginSettingEditPage getSettingEditPage()

getConfigurationSettingPanel

org.apache.wicket.markup.html.panel.Panel getConfigurationSettingPanel(java.lang.String panelId)

statusChanged

void statusChanged()

settingChanged

void settingChanged()

getClasspath

java.lang.String getClasspath()

getCategory

PluginCategory getCategory()

start

void start(BundleContext context)
           throws java.lang.Exception
Throws:
java.lang.Exception

stop

void stop(BundleContext context)
          throws java.lang.Exception
Throws:
java.lang.Exception


Copyright © 2005-2010 PMEase Inc. All Rights Reserved.