javax.portlet
public interface PortalContext
PortalContext
interface gives the portlet
the ability to retrieve information about the portal calling this portlet.
The portlet can only read the PortalContext
data.
Method Summary | |
---|---|
String | getPortalInfo()
Returns information about the portal like vendor, version, etc.
|
String | getProperty(String name)
Returns the portal property with the given name,
or a null if there is
no property by that name.
|
Enumeration | getPropertyNames()
Returns all portal property names, or an empty
Enumeration if there are no property names.
|
Enumeration | getSupportedPortletModes()
Returns all supported portlet modes by the portal
as an enumertation of PorltetMode objects.
|
Enumeration | getSupportedWindowStates()
Returns all supported window states by the portal
as an enumertation of WindowState objects.
|
The form of the returned string is servername/versionnumber. For
example, the reference implementation Pluto may return the string
Pluto/1.0
.
The portlet container may return other optional information after the
primary string in parentheses, for example, Pluto/1.0
(JDK 1.3.1; Windows NT 4.0 x86)
.
Returns: a String
containing at least the portal name and version number
null
if there is
no property by that name.
Parameters: name property name
Returns: portal property with key name
Throws: java.lang.IllegalArgumentException
if name is null
.
Enumeration
if there are no property names.
Returns: All portal property names as an
Enumeration
of String
objects
PorltetMode
objects.
The portlet modes must at least include the
standard portlet modes EDIT, HELP, VIEW
.
Returns: All supported portal modes by the portal
as an enumertation of PorltetMode
objects.
WindowState
objects.
The window states must at least include the
standard window states MINIMIZED, NORMAL, MAXIMIZED
.
Returns: All supported window states by the portal
as an enumertation of WindowState
objects.