org.proteios.core
Class PluginParameter<T>

java.lang.Object
  org.proteios.core.PluginParameter<T>

public class PluginParameter<T>
extends Object

Contains information about a single parameter that the plugin needs for a request.

Version:

2.0

Author:

Nicklas

See Also:

RequestInformation

Last modified

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

Constructor Summary

PluginParameter(String name, String label, String description, ParameterType<T> type)
Constructor that sets all members.

Method Summary

String	getDescription() Get a description of the parameter.
String	getLabel() Get the label of the parameter.
String	getName() Get the parameter name.
ParameterType<T>	getParameterType() Get the parameter type, which tells the client application the data type and allowed values for the parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginParameter

public PluginParameter(String name,
                       String label,
                       String description,
                       ParameterType<T> type)

Constructor that sets all members.

Parameters:

name - The name of the parameter.

label - Label that can be used in the GUI for the parameter.

type - The parameter type.

Method Detail

getName

public String getName()

Get the parameter name. This is the name of the parameter that the plugin use to identify the value with. This is the name the client application should use when calling PluginRequest.setParameterValue(String, Object).

Returns:

The name

getLabel

public String getLabel()

Get the label of the parameter. The label is a short string that a client application should display in the GUI.

Returns:

The label

getDescription

public String getDescription()

Get a description of the parameter. The description may be a longer help text explaining why the parameter is needed and what it is for.

Returns:

The label

getParameterType

public ParameterType<T> getParameterType()

Get the parameter type, which tells the client application the data type and allowed values for the parameter.

Returns:

A ParameterType object