org.apache.pluto.driver.services.portal
Interface SupportedModesService

All Superinterfaces:

DriverConfigurationService

public interface SupportedModesService
extends DriverConfigurationService

Allows clients to determine if a particular PortletMode is supported by the portal, a particular portlet, or both.

Since:

September 9, 2006

Version:

$Id: SupportedModesService.java 707252 2008-10-23 03:13:43Z cdoremus $

See Also:

PortletMode

Method Summary

javax.portlet.PortletConfig	getPortletConfig(java.lang.String portletId)
java.util.Set<javax.portlet.PortletMode>	getSupportedPortletModes(java.lang.String portletId) Gets all modes supported by a portlet that are defined in the portlet's supports child element in portlet.xml.
boolean	isPortletManagedMode(java.lang.String portletId, java.lang.String mode) For PTL.8.4 implementation of portlet-managed modes, defined in portlet.xml where portlet child element custom-portlet-mode/portal-managed value is false.
boolean	isPortletModeSupported(java.lang.String portletId, java.lang.String mode) Returns true if the portlet and the portal support the supplied mode.
boolean	isPortletModeSupportedByPortal(java.lang.String mode) Returns true if the portal supports the supplied mode.
boolean	isPortletModeSupportedByPortlet(java.lang.String portletId, java.lang.String mode) Returns true if the portlet supports the supplied mode.

Methods inherited from interface org.apache.pluto.driver.services.portal.DriverConfigurationService

destroy, init

Method Detail

isPortletModeSupported

boolean isPortletModeSupported(java.lang.String portletId,
                               java.lang.String mode)

Returns true if the portlet and the portal support the supplied mode.

Parameters:

portletId - the id uniquely identifiying the portlet

mode - the portlet mode

Returns:

true if the portlet and portal both support the supplied mode

isPortletModeSupportedByPortal

boolean isPortletModeSupportedByPortal(java.lang.String mode)

Returns true if the portal supports the supplied mode.

Parameters:

mode - the portlet mode

Returns:

true if the portal supports the supplied mode

isPortletModeSupportedByPortlet

boolean isPortletModeSupportedByPortlet(java.lang.String portletId,
                                        java.lang.String mode)

Returns true if the portlet supports the supplied mode.

Parameters:

portletId - the id uniquely identifying the portlet

mode - the portlet mode

Returns:

true if the portlet supports the supplied mode.

isPortletManagedMode

boolean isPortletManagedMode(java.lang.String portletId,
                             java.lang.String mode)

For PTL.8.4 implementation of portlet-managed modes, defined in portlet.xml where portlet child element custom-portlet-mode/portal-managed value is false.

Parameters:

portletId - the ID of the portlet

mode - the portlet mode as defined in the custom-portlet-mode/portlet-mode and supports/portlet-mode elements.

Returns:

getSupportedPortletModes

java.util.Set<javax.portlet.PortletMode> getSupportedPortletModes(java.lang.String portletId)
                                                                  throws PortletContainerException

Gets all modes supported by a portlet that are defined in the portlet's supports child element in portlet.xml.

Parameters:

portletId - Id of the portlet of interest

Returns:

all portlet modes supported by a portlet.

Throws:

PortletContainerException

getPortletConfig

javax.portlet.PortletConfig getPortletConfig(java.lang.String portletId)
                                             throws PortletContainerException

Throws:

PortletContainerException