|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.objectplanet.survey.plugin.Plugin
Plugin is an abstract class that all plugins must implement. The methods required is interface between the system and a plugin.
Nested Class Summary | |
static class |
Plugin.Broken
A placeholder for a plugin that didn't load. |
static class |
Plugin.JAR
A JAR file. |
Constructor Summary | |
Plugin()
|
Method Summary | |
java.lang.String |
getActionHTML()
NOTE: this method is not yet used by Opinio. |
java.lang.String |
getClassName()
Returns the plugin's class name. |
java.lang.String |
getErrorMsg()
Sets the error message |
java.lang.String |
getHelpHTML()
NOTE: this method is not yet used by Opinio. |
Plugin.JAR |
getJAR()
Returns the JAR file containing this plugin. |
java.lang.String |
getSetupHTML()
Gets the HTML code needed to perform setup/config operations on this plugin. |
java.lang.String |
processSetup(java.util.Map values)
Method for processing the setup screen. |
void |
setErrorMsg(java.lang.String errorMsg)
Sets the error message. |
void |
start()
Any PluginBus registrations should be done here. |
void |
stop()
Method called by the system before exiting. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Plugin()
Method Detail |
public java.lang.String getClassName()
public Plugin.JAR getJAR()
public final void setErrorMsg(java.lang.String errorMsg)
errorMsg
- The error messagepublic final java.lang.String getErrorMsg()
public java.lang.String getSetupHTML()
public java.lang.String getActionHTML()
public java.lang.String getHelpHTML()
public void start()
public void stop()
public java.lang.String processSetup(java.util.Map values)
values
- The values entered by the user in the setup screen.
|
Copyright © ObjectPlanet Inc. All Rights Reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |