|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 window states 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. |
Method Detail |
---|
String getProperty(String name)
null
if there is
no property by that name.
name
- property name
name
IllegalArgumentException
- if name is null
.Enumeration getPropertyNames()
Enumeration
if there are no property names.
Enumeration
of String
objectsEnumeration getSupportedPortletModes()
PorltetMode
objects.
The portlet modes must at least include the
standard portlet modes EDIT, HELP, VIEW
.
PorltetMode
objects.Enumeration getSupportedWindowStates()
WindowState
objects.
The window states must at least include the
standard window states MINIMIZED, NORMAL, MAXIMIZED
.
WindowState
objects.String getPortalInfo()
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)
.
String
containing at least the portlet container name and version number
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |