Package javax.portlet
Interface PortalContext
-
public interface PortalContext
ThePortalContext
interface gives the portlet the ability to retrieve information about the portal calling this portlet.The portlet can only read the
PortalContext
data.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
MARKUP_HEAD_ELEMENT_SUPPORT
Property indicating if the portal application supports theMimeResponse
propertyMARKUP_HEAD_ELEMENT
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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 anull
if there is no property by that name.java.util.Enumeration<java.lang.String>
getPropertyNames()
Returns all portal property names, or an emptyEnumeration
if there are no property names.java.util.Enumeration<PortletMode>
getSupportedPortletModes()
Returns all supported portlet modes by the portal as an enumeration ofPortletMode
objects.java.util.Enumeration<WindowState>
getSupportedWindowStates()
Returns all supported window states by the portal as an enumeration ofWindowState
objects.
-
-
-
Field Detail
-
MARKUP_HEAD_ELEMENT_SUPPORT
static final java.lang.String MARKUP_HEAD_ELEMENT_SUPPORT
Property indicating if the portal application supports theMimeResponse
propertyMARKUP_HEAD_ELEMENT
.A non-null value indicates that the portal application supports the
MARKUP_HEAD_ELEMENT
property.The value is
"javax.portlet.markup.head.element.support"
.- Since:
- 2.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
getProperty
java.lang.String getProperty(java.lang.String name)
Returns the portal property with the given name, or anull
if there is no property by that name.- Parameters:
name
- property name- Returns:
- portal property with key
name
- Throws:
java.lang.IllegalArgumentException
- if name isnull
.
-
getPropertyNames
java.util.Enumeration<java.lang.String> getPropertyNames()
Returns all portal property names, or an emptyEnumeration
if there are no property names.- Returns:
- All portal property names as an
Enumeration
ofString
objects
-
getSupportedPortletModes
java.util.Enumeration<PortletMode> getSupportedPortletModes()
Returns all supported portlet modes by the portal as an enumeration ofPortletMode
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 enumeration of
PortletMode
objects.
-
getSupportedWindowStates
java.util.Enumeration<WindowState> getSupportedWindowStates()
Returns all supported window states by the portal as an enumeration ofWindowState
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 enumeration of
WindowState
objects.
-
getPortalInfo
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)
.- Returns:
- a
String
containing at least the portal name and version number
-
-