org.apache.pluto.om.common
Interface Parameter

All Superinterfaces:

Model

public interface Parameter

extends Model

This interface provides access to a parameter and its attributes. A parameter is defined in the web.xml or in the portlet.xml of a portlet application archive file.

This interface defines the model as known from the MVC pattern. Its purpose is to provide read access to the data stored in the model.

Method Summary

Description	getDescription(java.util.Locale locale) Returns the description for the given locale The return value may be NULL.
java.lang.String	getName() Returns the name The return value cannot be NULL.
java.lang.String	getValue() Returns the value The return value may be NULL.

Method Detail

getName

public java.lang.String getName()

Returns the name The return value cannot be NULL.

Returns:

the name

getValue

public java.lang.String getValue()

Returns the value The return value may be NULL.

Returns:

the value

getDescription

public Description getDescription(java.util.Locale locale)

Returns the description for the given locale The return value may be NULL.

Returns:

the localized description