|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Request
Pass request information to a plugin. Objects implementing
this interface are used by the core to pass information to a
plugin in the Plugin.run(Request, Response, ProgressReporter)
method. Commands are used to tell the plugin what kind of information
the user want to pass to the plugin.
There are three predefind request commands that all plugins understands,
those three are COMMAND_CONFIGURE_JOB
,
COMMAND_CONFIGURE_PLUGIN
and
COMMAND_EXECUTE
. The configuration setup starts by giving the
plugin the command COMMAND_CONFIGURE_PLUGIN
and it will be saved in the PluginConfiguration
that instantiated the plugin. The starting command for setting the job parameters are the
COMMAND_CONFIGURE_PLUGIN
command.
After the request have been invoked the plugin will respond with a Response
.
The status of the respond will tell the Job
how to proceed.
Plugin defined commands are not allowed to use strings that begins with
an underscore("_"). Strings starting with an underscore is reserved for the
Base 2 system.
Field Summary | |
---|---|
static String |
COMMAND_CONFIGURE_JOB
This should be the first command to use when setting the plugin's job parameters. |
static String |
COMMAND_CONFIGURE_PLUGIN
This should be the first command to use when setting the plugin's configuration. |
static String |
COMMAND_EXECUTE
This command will tell the plugin to start its execution. |
Method Summary | |
---|---|
String |
getCommand()
The command the plugin should execute. |
Object |
getParameterValue(String name)
Get the value for the parameter with the specified name. |
List<?> |
getParameterValues(String name)
Get the values for the parameter with the specified name. |
boolean |
isAllowedImmediateExecution()
If this plugin has been allowed immediate execution or not. |
Field Detail |
---|
static final String COMMAND_CONFIGURE_PLUGIN
static final String COMMAND_CONFIGURE_JOB
static final String COMMAND_EXECUTE
Method Detail |
---|
String getCommand()
List<?> getParameterValues(String name)
name
- The name of the parameter
Object getParameterValue(String name) throws ParameterException
name
- The name of the parameter
ParameterException
- If getting the value fails.boolean isAllowedImmediateExecution()
Response.setExecuteImmediately(String, Job.ExecutionTime, boolean)
or, if the plugin is a ImmediateDownloadExporter
,
Response.setDownloadImmediately(String, Job.ExecutionTime, boolean)
.
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |