Java Portlet API V3.0 3.0.1 · javax.portlet.PortalContext

Modifier and Type	Field and Description
public static final String	MARKUP_HEAD_ELEMENT_SUPPORT Property indicating if the portal application supports the `MimeResponse` property `MARKUP_HEAD_ELEMENT`.

Method Summary

Modifier and Type	Method and Description
public String	Returns: a `String` containing at least the portal name and version number getPortalInfo() Returns information about the portal like vendor, version, etc. The form of the returned string is servername/versionnumber.
public String	Returns: portal property with key `name` getProperty(String property name name) Returns the portal property with the given name, or a `null` if there is no property by that name.
public Enumeration<String>	Returns: All portal property names as an `Enumeration` of `String` objects getPropertyNames() Returns all portal property names, or an empty `Enumeration` if there are no property names.
public Enumeration<PortletMode>	Returns: All supported portal modes by the portal as an enumeration of `PortletMode` objects. getSupportedPortletModes() Returns all supported portlet modes by the portal as an enumeration of `PortletMode` objects.
public Enumeration<WindowState>	Returns: All supported window states by the portal as an enumeration of `WindowState` objects. getSupportedWindowStates() Returns all supported window states by the portal as an enumeration of `WindowState` objects.

Field Detail

MARKUP_HEAD_ELEMENT_SUPPORT back to summary

MARKUP_HEAD_ELEMENT_SUPPORT	back to summary
public static final String MARKUP_HEAD_ELEMENT_SUPPORT Property indicating if the portal application supports the `MimeResponse` property `MARKUP_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

public static final String MARKUP_HEAD_ELEMENT_SUPPORT

Property indicating if the portal application supports the MimeResponse property MARKUP_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

Method Detail

getPortalInfo back to summary

getPortalInfo	back to summary
public 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:String a `String` containing at least the portal name and version number

public 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:String: a String containing at least the portal name and version number

getProperty back to summary

getProperty	back to summary
public String getProperty(String name) Returns the portal property with the given name, or a `null` if there is no property by that name. Parameters name:String property name Returns:String portal property with key `name` Exceptions IllegalArgumentException: if name is `null`.

public String getProperty(String name)

Returns the portal property with the given name, or a null if there is no property by that name.

Parameters

name:String: property name

Returns:String

portal property with key name

Exceptions

IllegalArgumentException:: if name is null.

getPropertyNames back to summary

getPropertyNames	back to summary
public Enumeration<String> getPropertyNames() Returns all portal property names, or an empty `Enumeration` if there are no property names. Returns:Enumeration<String> All portal property names as an `Enumeration` of `String` objects

public Enumeration<String> getPropertyNames()

Returns all portal property names, or an empty Enumeration if there are no property names.

Returns:Enumeration<String>: All portal property names as an Enumeration of String objects

getSupportedPortletModes back to summary

getSupportedPortletModes	back to summary
public Enumeration<PortletMode> getSupportedPortletModes() Returns all supported portlet modes by the portal as an enumeration of `PortletMode` objects. The portlet modes must at least include the standard portlet modes `EDIT, HELP, VIEW`. Returns:Enumeration<PortletMode> All supported portal modes by the portal as an enumeration of `PortletMode` objects.

public Enumeration<PortletMode> getSupportedPortletModes()

Returns all supported portlet modes by the portal as an enumeration of PortletMode objects.

The portlet modes must at least include the standard portlet modes EDIT, HELP, VIEW.

Returns:Enumeration<PortletMode>: All supported portal modes by the portal as an enumeration of PortletMode objects.

getSupportedWindowStates back to summary

getSupportedWindowStates	back to summary
public Enumeration<WindowState> getSupportedWindowStates() Returns all supported window states by the portal as an enumeration of `WindowState` objects. The window states must at least include the standard window states `MINIMIZED, NORMAL, MAXIMIZED`. Returns:Enumeration<WindowState> All supported window states by the portal as an enumeration of `WindowState` objects.

public Enumeration<WindowState> getSupportedWindowStates()

Returns all supported window states by the portal as an enumeration of WindowState objects.

The window states must at least include the standard window states MINIMIZED, NORMAL, MAXIMIZED.

Returns:Enumeration<WindowState>: All supported window states by the portal as an enumeration of WindowState objects.

public Interface PortalContext

Field Summary

Method Summary

Field Detail

Method Detail