org.apache.jetspeed.portlet
Interface PortletConfig

All Superinterfaces:

javax.servlet.ServletConfig

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:

Stephan Hesmer

See Also:

Portlet

Method Summary

PortletContext	getContext() Returns the portlet context.
java.lang.String	getName() Returns the name of the portlet.
boolean	supports(Portlet.Mode mode, Client client) Returns whether the portlet supports the given mode for the given client.
boolean	supports(PortletWindow.State state) Returns whether the portlet window supports the given state

Methods inherited from interface javax.servlet.ServletConfig

getInitParameter, getInitParameterNames, getServletContext, getServletName

Method Detail

getName

public java.lang.String getName()

Returns the name of the portlet. The portlet container needs the portlet name for administration purposes.

Returns:

the portlet name

supports

public boolean supports(PortletWindow.State state)

Returns whether the portlet window supports the given state

Parameters:

state - the portlet window state to be supported

Returns:

true if the portlet window provides support,
false otherwise

supports

public boolean supports(Portlet.Mode mode,
                        Client client)

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

Parameters:

mode - the portlet mode to be supported

client - the client to be supported

Returns:

true if the portlet provides support,
false otherwise

getContext

public PortletContext getContext()

Returns the portlet context.

Returns:

the portlet context