com.atlassian.jira.web.component
Interface DashboardPageConfigUrlFactory

All Known Implementing Classes:

DashboardPageConfigUrlFactoryImpl

public interface DashboardPageConfigUrlFactory

Responsible for creating URLs for editing the state and dashboard page location of portlets. The URLs should be relative to context root.

Since:

v3.13

Nested Class Summary

static interface

DashboardPageConfigUrlFactory.PortletConfigurationAdaptor Abstraction for describing the aspects of the PortletConfiguration object graph that we depend on without depending on all the mechanical details like ObjectConfiguration and PropertySet.

Method Summary

String	getEditPortletUrl(Long portletConfigId) Returns a URL for configuring portlets on the dashboard.
String	getRunPortletUrl(DashboardPageConfigUrlFactory.PortletConfigurationAdaptor configurationAccessor) Returns a URL for RunPortlet action that will execute the given portlet configuration.

Method Detail

getRunPortletUrl

String getRunPortletUrl(DashboardPageConfigUrlFactory.PortletConfigurationAdaptor configurationAccessor)

Returns a URL for RunPortlet action that will execute the given portlet configuration.

Parameters:

configurationAccessor - portlet configuration

Returns:

URL as String, never null

getEditPortletUrl

String getEditPortletUrl(Long portletConfigId)

Returns a URL for configuring portlets on the dashboard.

Parameters:

portletConfigId - the portlet to configure.

Returns:

the URL, never null.