public class RequestInformation extends Object
PluginRequest
for more information.PluginRequest
Modifier and Type | Field and Description |
---|---|
private String |
command |
private String |
description |
private String |
jspPage |
private Map<String,PluginParameter<?>> |
parameterMap |
private List<PluginParameter<?>> |
parameters |
private String |
title |
Constructor and Description |
---|
RequestInformation(String command,
String title,
String description,
List<PluginParameter<?>> parameters) |
RequestInformation(String command,
String title,
String description,
List<PluginParameter<?>> parameters,
String jspPage) |
Modifier and Type | Method and Description |
---|---|
private void |
createParameterMap()
Create a hash from parameter name to PluginParameter objects
so that the
getParameter(String) method doesn't have
to look in the list. |
String |
getCommand()
Get the command this request information object is valid for.
|
String |
getDescription()
Get a description of the request.
|
String |
getJspPage()
The name of the jsp page to use for displaying the input form for
requesting parameters.
|
PluginParameter<?> |
getParameter(String name)
Get the plugin parameter with the specified name.
|
List<PluginParameter<?>> |
getParameters()
Get a list containing the information about the parameters
needed for the current request.
|
String |
getTitle()
Get the title of the request.
|
private final String command
private final String description
private final String title
private final List<PluginParameter<?>> parameters
private final String jspPage
private Map<String,PluginParameter<?>> parameterMap
public RequestInformation(String command, String title, String description, List<PluginParameter<?>> parameters)
public String getCommand()
public String getTitle()
public String getDescription()
public List<PluginParameter<?>> getParameters()
List
with PluginParameter
:spublic PluginParameter<?> getParameter(String name)
name
- Name of the plugin parameter.public String getJspPage()
This method can return an absolute path or only the filename of the JSP file.
/plugins
directory,
where the subdirectory is given by the package name of the plugin.
Eg. the plugin net.sf.basedb.plugins.APlugin
would
have all it's JSP files located in the /plugins/net/sf/basedb/plugins
directory.
The JSP page must conform to certain rules, ie. names of input fields, etc. See the BASE manual for more information.
private void createParameterMap()
getParameter(String)
method doesn't have
to look in the list.