com.liferay.faces.bridge.context.url
Interface BridgeResponseURL

All Superinterfaces:

BridgeURL

All Known Subinterfaces:

BridgeActionURL, BridgeRedirectURL

All Known Implementing Classes:

BridgeActionURLImpl, BridgeActionURLWrapper, BridgeRedirectURLImpl, BridgeRedirectURLWrapper, BridgeResponseURLImpl

public interface BridgeResponseURL
extends BridgeURL

This interface represents a bridge "response" URL, meaning a URL that has convenience methods for representing URLs according to the deviation requirements of ExternalContext.encodeResourceURL(String) listed in Section 6.1.3.1 of the Bridge Spec.

Author:

Neil Griffin

Method Summary

void

applyToResponse(javax.portlet.StateAwareResponse stateAwareResponse) Convenience method that applies the parameters found in this URL to the specified StateAwareResponse by calling methods such as StateAwareResponse.setPortletMode(javax.portlet.PortletMode) and StateAwareResponse.setWindowState(javax.portlet.WindowState), etc.

Methods inherited from interface com.liferay.faces.bridge.context.url.BridgeURL

getContextRelativePath, getParameter, getParameterMap, getParameterNames, getPortletPhase, isAbsolute, isEscaped, isExternal, isFacesViewTarget, isHierarchical, isOpaque, isPathRelative, isPortletScheme, isSecure, isSelfReferencing, removeParameter, setParameter, setParameter, setSecure, setSelfReferencing, toString

Method Detail

applyToResponse

void applyToResponse(javax.portlet.StateAwareResponse stateAwareResponse)
                     throws javax.portlet.PortletModeException,
                            javax.portlet.WindowStateException

Convenience method that applies the parameters found in this URL to the specified StateAwareResponse by calling methods such as StateAwareResponse.setPortletMode(javax.portlet.PortletMode) and StateAwareResponse.setWindowState(javax.portlet.WindowState), etc.

Parameters:

stateAwareResponse - The current response.

Throws:

javax.portlet.PortletModeException - If Bridge.PORTLET_MODE_PARAMETER has an invalid value.

javax.portlet.WindowStateException - If Bridge.PORTLET_WINDOWSTATE_PARAMETER has an invalid value.