com.liferay.faces.bridge.ext.filter.internal

Interface LiferayURLGenerator

All Known Implementing Classes:

LiferayURLGeneratorActionImpl, LiferayURLGeneratorBaseImpl, LiferayURLGeneratorRenderImpl, LiferayURLGeneratorResourceImpl

public interface LiferayURLGenerator

This interface defines a contract for generating URLs that are compatible with Liferay Portal.

Author:

Neil Griffin

Method Summary

Methods

Modifier and Type	Method and Description
String	generateURL(Map<String,String[]> additionalParameterMap) Generates a Liferay-compatible URL with the specified additional URL parameters.
String	generateURL(Map<String,String[]> additionalParameterMap, javax.portlet.PortletMode portletMode, javax.portlet.WindowState windowState) Generates a Liferay-compatible URL with the specified additional URL parameters, portlet mode, and window state.
String	generateURL(Map<String,String[]> additionalParameterMap, String cacheability, String resourceId) Generates a Liferay-compatible URL with the specified additional URL parameters and resource ID.
String	getPortletLifecycleId() Returns the portlet lifecycle ID for type of URL generator.

Method Detail

generateURL

String generateURL(Map<String,String[]> additionalParameterMap)

Generates a Liferay-compatible URL with the specified additional URL parameters.

Parameters:

additionalParameterMap - Additional URL parameters.

Returns:

The Liferay-compatible URL.

generateURL

String generateURL(Map<String,String[]> additionalParameterMap,
                 String cacheability,
                 String resourceId)

Generates a Liferay-compatible URL with the specified additional URL parameters and resource ID.

Parameters:

additionalParameterMap - Additional URL parameters.

resourceId - The resource ID.

cacheability - The resource's cacheability level.

Returns:

The Liferay-compatible URL.

generateURL

String generateURL(Map<String,String[]> additionalParameterMap,
                 javax.portlet.PortletMode portletMode,
                 javax.portlet.WindowState windowState)

Generates a Liferay-compatible URL with the specified additional URL parameters, portlet mode, and window state.

Parameters:

additionalParameterMap - Additional URL parameters.

portletMode - The portlet mode.

windowState - The window state.

Returns:

getPortletLifecycleId

String getPortletLifecycleId()

Returns the portlet lifecycle ID for type of URL generator.