| javax.portlet.PortletConfig
All known Subclasses: com.sun.portal.portlet.impl.PortletConfigImpl, javax.portlet.GenericPortlet,
PortletConfig | public interface PortletConfig (Code) | | The PortletConfig interface provides the portlet with
its configuration. The configuration holds information about the
portlet that is valid for all users. The configuration is retrieved
from the portlet definition in the deployment descriptor.
The portlet can only read the configuration data.
The configuration information contains the portlet name, the portlet
initialization parameters, the portlet resource bundle and the portlet
application context.
See Also: Portlet |
getInitParameter | public String getInitParameter(java.lang.String name)(Code) | | Returns a String containing the value of the named initialization parameter,
or null if the parameter does not exist.
Parameters: name - a String specifying the nameof the initialization parameter a String containing the value of the initialization parameter exception: java.lang.IllegalArgumentException - if name is null . |
getInitParameterNames | public java.util.Enumeration getInitParameterNames()(Code) | | Returns the names of the portlet initialization parameters as an
Enumeration of String objects, or an empty Enumeration if the
portlet has no initialization parameters.
an Enumeration of String objects containing the names of the portlet initialization parameters, or an empty Enumeration if the portlet has no initialization parameters. |
getPortletContext | public PortletContext getPortletContext()(Code) | | Returns the PortletContext of the portlet application
the portlet is in.
a PortletContext object, used by the caller to interact with its portlet container See Also: PortletContext |
getPortletName | public String getPortletName()(Code) | | Returns the name of the portlet.
The name may be provided via server administration, assigned in the
portlet application deployment descriptor with the portlet-name
tag.
the portlet name |
getResourceBundle | public java.util.ResourceBundle getResourceBundle(java.util.Locale locale)(Code) | | Gets the resource bundle for the given locale based on the
resource bundle defined in the deployment descriptor
with resource-bundle tag or the inlined resources
defined in the deployment descriptor.
Parameters: locale - the locale for which to retrieve the resource bundle the resource bundle for the given locale |
|
|