org.pentaho.platform.web.portal
Class PortletUrlFactory

java.lang.Object
  org.pentaho.platform.web.portal.PortletUrlFactory

All Implemented Interfaces:

IPentahoUrlFactory

public class PortletUrlFactory
extends Object
implements IPentahoUrlFactory

Factories up implementations of IPentahoUrl. In this case, the implementation is org.pentaho.ui.portlet.PortletUrl. Warning: do not hold on to instances of this class beyond the current request/response cycle. This class maintains a reference to the RenderResponse, which is only valid in the request/response cycle in which it was created. Note: this class uses two similarly named classes: PortletURL and PortletUrl. Don't let this confuse you as you read the code.

Author:

James Dixon, mods by Steven Barkdull

Constructor Summary

PortletUrlFactory(javax.portlet.RenderResponse portletResponse, javax.portlet.WindowState state, javax.portlet.PortletMode mode)

Method Summary

IPentahoUrl	getActionUrlBuilder() Get a URL builder that is appropriate for building action URLs.
IPentahoUrl	getDisplayUrlBuilder() Get a URL builder that is appropriate for building render URLs.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletUrlFactory

public PortletUrlFactory(javax.portlet.RenderResponse portletResponse,
                         javax.portlet.WindowState state,
                         javax.portlet.PortletMode mode)

Method Detail

getActionUrlBuilder

public IPentahoUrl getActionUrlBuilder()

Get a URL builder that is appropriate for building action URLs.

Specified by:

getActionUrlBuilder in interface IPentahoUrlFactory

Returns:

the action URL

Throws:

UIException - when one of the underlying PortletURL's set methods throw an exception. See docs for PortletURL: http://docs.jboss.org/jbportal/v2.0Final/javadoc/javax/portlet/PortletURL.html

getDisplayUrlBuilder

public IPentahoUrl getDisplayUrlBuilder()

Get a URL builder that is appropriate for building render URLs.

Specified by:

getDisplayUrlBuilder in interface IPentahoUrlFactory

Returns:

The URL builder

Throws:

UIException - when one of the underlying PortletURL's set methods throw an exception. See docs for PortletURL: http://docs.jboss.org/jbportal/v2.0Final/javadoc/javax/portlet/PortletURL.html