public class RequestInformation
extends java.lang.Object
PluginRequest
for more information.PluginRequest
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
command |
private java.lang.String |
description |
private java.lang.String |
jspPage |
private java.util.Map<java.lang.String,PluginParameter<?>> |
parameterMap |
private java.util.List<PluginParameter<?>> |
parameters |
private java.lang.String |
title |
Constructor and Description |
---|
RequestInformation(java.lang.String command,
java.lang.String title,
java.lang.String description,
java.util.List<PluginParameter<?>> parameters) |
RequestInformation(java.lang.String command,
java.lang.String title,
java.lang.String description,
java.util.List<PluginParameter<?>> parameters,
java.lang.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. |
java.lang.String |
getCommand()
Get the command this request information object is valid for.
|
java.lang.String |
getDescription()
Get a description of the request.
|
java.lang.String |
getJspPage()
The name of the jsp page to use for displaying the input form for
requesting parameters.
|
PluginParameter<?> |
getParameter(java.lang.String name)
Get the plugin parameter with the specified name.
|
java.util.List<PluginParameter<?>> |
getParameters()
Get a list containing the information about the parameters
needed for the current request.
|
java.lang.String |
getTitle()
Get the title of the request.
|
private final java.lang.String command
private final java.lang.String description
private final java.lang.String title
private final java.util.List<PluginParameter<?>> parameters
private final java.lang.String jspPage
private java.util.Map<java.lang.String,PluginParameter<?>> parameterMap
public RequestInformation(java.lang.String command, java.lang.String title, java.lang.String description, java.util.List<PluginParameter<?>> parameters)
public RequestInformation(java.lang.String command, java.lang.String title, java.lang.String description, java.util.List<PluginParameter<?>> parameters, java.lang.String jspPage)
public java.lang.String getCommand()
public java.lang.String getTitle()
public java.lang.String getDescription()
public java.util.List<PluginParameter<?>> getParameters()
List
with PluginParameter
:spublic PluginParameter<?> getParameter(java.lang.String name)
name
- Name of the plugin parameter.public java.lang.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.