javax.portlet
Interface PortalContext
public interface PortalContext
The
PortalContext
interface gives the portlet
the ability to retrieve information about the portal calling this portlet.
The portlet can only read the
PortalContext
data.
java.lang.String | getPortalInfo() - Returns information about the portal like vendor, version, etc.
|
java.lang.String | getProperty(java.lang.String name) - Returns the portal property with the given name,
or a
null if there is
no property by that name.
|
java.util.Enumeration | getPropertyNames() - Returns all portal property names, or an empty
Enumeration if there are no property names.
|
java.util.Enumeration | getSupportedPortletModes() - Returns all supported portlet modes by the portal
as an enumertation of
PorltetMode objects.
|
java.util.Enumeration | getSupportedWindowStates() - Returns all supported window states by the portal
as an enumertation of
WindowState objects.
|
getPortalInfo
public java.lang.String getPortalInfo()
Returns information about the portal like vendor, version, etc.
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)
.
- a
String
containing at least the portal name and version number
getProperty
public java.lang.String getProperty(java.lang.String name)
Returns the portal property with the given name,
or a null
if there is
no property by that name.
- portal property with key
name
getPropertyNames
public java.util.Enumeration getPropertyNames()
Returns all portal property names, or an empty
Enumeration
if there are no property names.
- All portal property names as an
Enumeration
of String
objects
getSupportedPortletModes
public java.util.Enumeration getSupportedPortletModes()
Returns all supported portlet modes by the portal
as an enumertation of
PorltetMode
objects.
The portlet modes must at least include the
standard portlet modes
EDIT, HELP, VIEW
.
- All supported portal modes by the portal
as an enumertation of
PorltetMode
objects.
getSupportedWindowStates
public java.util.Enumeration getSupportedWindowStates()
Returns all supported window states by the portal
as an enumertation of
WindowState
objects.
The window states must at least include the
standard window states
MINIMIZED, NORMAL, MAXIMIZED
.
- All supported window states by the portal
as an enumertation of
WindowState
objects.