net.sf.jportlet.portlet
Interface PortletConfig

All Superinterfaces:

javax.servlet.ServletConfig

All Known Implementing Classes:

PortletConfigImpl

public interface PortletConfig

extends javax.servlet.ServletConfig

The PortletConfig interface provides the portlet with its configuration. The configuration holds information about the portlet that is valid for all users, and is maintained by the developer. The portlet can therefore only read the configuration

Author:

Herve Tchepannou

Method Summary

java.lang.String	getInitParameter(java.lang.String name)
java.util.Enumeration	getInitParameterNames()
net.sf.jportlet.portlet.PortletContext	getPortletContext() Returns the context of the portlet
java.lang.String	getPortletName() Returns the name of the portlet
boolean	supports(Portlet.Mode mode, net.sf.jportlet.portlet.Client client) Returns whether the portlet supports the given mode for the given client.

Methods inherited from interface javax.servlet.ServletConfig

getServletContext, getServletName

Method Detail

getInitParameter

public java.lang.String getInitParameter(java.lang.String name)

Specified by:

getInitParameter in interface javax.servlet.ServletConfig

See Also:

ServletConfig.getInitParameter(java.lang.String)

getInitParameterNames

public java.util.Enumeration getInitParameterNames()

Specified by:

getInitParameterNames in interface javax.servlet.ServletConfig

See Also:

ServletConfig.getInitParameterNames()

getPortletContext

public net.sf.jportlet.portlet.PortletContext getPortletContext()

Returns the context of the portlet

Returns:

PortletContext

getPortletName

public java.lang.String getPortletName()

Returns the name of the portlet

Returns:

String

supports

public boolean supports(Portlet.Mode mode,
                        net.sf.jportlet.portlet.Client client)

Returns whether the portlet supports the given mode for the given client.

Parameters:

mode -

client -

Returns:

boolean