|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Action
Defines the actions a plugin can request to execute after installation.
An action is defined in a plugin's xml file. The declaration is:
<action id="actionname" set of parameters>
The only registered attribute name is id
, used to identify the action.
The set of parameters depends on each action type.
Method Summary | |
---|---|
boolean |
execute()
Request the action to execute. |
java.lang.String |
getFailureReason()
Gets the failure reason. |
java.util.Collection |
getMandatoryParameters()
Get the Madatory parameters needed by the action to execute |
java.lang.String |
getName()
Gets the action name. |
java.util.Collection |
getOptionalParameters()
Get the Optional/b> parameters needed by the action to execute |
java.lang.String |
getOwnerPlugin()
Gets the name of the plugin owner of this action |
Version |
getOwnerPluginVersion()
Gets the version of the plugin owner of this action |
java.lang.String |
getQuestionToUser()
If showAskUser() returns true, this method is called to get the Question. |
java.util.Collection |
requiredPlugins()
Gets the required plugins to execute this action. |
void |
setParamenters(java.util.Properties params)
Sets the parameters obtained from the plugin xml file. |
boolean |
shouldAskUser()
Should the Plugin Manager ask for user confirmation before executing the action. |
Method Detail |
---|
java.lang.String getName()
java.util.Collection requiredPlugins()
java.util.Collection getMandatoryParameters()
Action.getOptionalParameters()
java.util.Collection getOptionalParameters()
Action.getMadatoryParameters()
void setParamenters(java.util.Properties params)
params
will contain both, mandatory and optional parameters
params
- set of parametersboolean execute()
java.lang.String getFailureReason()
false
boolean shouldAskUser()
java.lang.String getQuestionToUser()
java.lang.String getOwnerPlugin()
Version getOwnerPluginVersion()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |