org.proteios.core
Class RequestInformation

java.lang.Object
  org.proteios.core.RequestInformation

public class RequestInformation
extends Object

Get information about the parameters the plugin needs for a particular request. See PluginRequest for more information.

Version:

2.0

Author:

Enell, Nicklas

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Constructor Summary

RequestInformation(String command, String title, String description, List<PluginParameter<?>> parameters)

RequestInformation(String command, String title, String description, List<PluginParameter<?>> parameters, String jspPage)

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestInformation

public RequestInformation(String command,
                          String title,
                          String description,
                          List<PluginParameter<?>> parameters)

RequestInformation

public RequestInformation(String command,
                          String title,
                          String description,
                          List<PluginParameter<?>> parameters,
                          String jspPage)

Method Detail

getCommand

public String getCommand()

Get the command this request information object is valid for.

Returns:

The name of the command

getTitle

public String getTitle()

Get the title of the request. A client application can use this text as a page header.

getDescription

public String getDescription()

Get a description of the request. A client application can use this information as a help text describing the current configuration page.

getParameters

public List<PluginParameter<?>> getParameters()

Get a list containing the information about the parameters needed for the current request.

getParameter

public PluginParameter<?> getParameter(String name)

Get the plugin parameter with the specified name.

Returns:

The PluginParameter objec or null if no parameter with that name exists

getJspPage

public String getJspPage()

The name of the jsp page to use for displaying the input form for requesting parameters. This is only used by the web client application (or compatible). It is recommended that a plugin do not depend on the JSP page for parameter input.

This method should return the name of the JSP page only, not the path. It must be located in a subdirectory to the /plugins directory, where the subdirectory is given by the package name of the plugin. Ie. the plugin org.proteios.plugins.APlugin would have all it's JSP pages located in the /plugins/org/proteios/plugins directory.

TODO - the JSP page must conform to certain rules, ie. names of input fields, etc. create other documentation for that and link to it from here

Returns:

The name of the JSP page or null if this request doesn't require a JSP page.