com.atlassian.jira.web.component
Class DashboardPageConfigUrlFactoryImpl

java.lang.Object
  extended by com.atlassian.jira.web.component.DashboardPageConfigUrlFactoryImpl
All Implemented Interfaces:
DashboardPageConfigUrlFactory

public class DashboardPageConfigUrlFactoryImpl
extends Object
implements DashboardPageConfigUrlFactory

Main implementation of DashboardPageConfigUrlFactory which links portlet configuration to the original dashboard and dashboard config actions.

Since:
v3.13

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.atlassian.jira.web.component.DashboardPageConfigUrlFactory
DashboardPageConfigUrlFactory.PortletConfigurationAdaptor
 
Constructor Summary
DashboardPageConfigUrlFactoryImpl(Long portalPageId)
           
 
Method Summary
 String getAddPortletUrl()
          Returns a URL for adding a portlet to the dashboard.
 String getDashboardBaseUrl(Long portletConfigurationId)
          Returns a URL for dashboard configuration operation.
 String getEditPortletUrl(Long portletConfigId)
          Returns a URL for configuring portlets on the dashboard.
 String getPortletOperationUrl(Long portletId, String operationName)
          Returns a URL for dashboard configuration operation.
 String getRunPortletUrl(DashboardPageConfigUrlFactory.PortletConfigurationAdaptor accessor)
          Returns a URL for RunPortlet action that will execute the given portlet configuration.
 String getRunPortletUrl(PortletConfiguration portletConfiguration)
          Returns a URL for RunPortlet action that will execute the given portlet configuration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DashboardPageConfigUrlFactoryImpl

public DashboardPageConfigUrlFactoryImpl(Long portalPageId)
Method Detail

getRunPortletUrl

public String getRunPortletUrl(PortletConfiguration portletConfiguration)
Description copied from interface: DashboardPageConfigUrlFactory
Returns a URL for RunPortlet action that will execute the given portlet configuration.

Specified by:
getRunPortletUrl in interface DashboardPageConfigUrlFactory
Parameters:
portletConfiguration - portlet configuration
Returns:
URL as String, never null

getRunPortletUrl

public String getRunPortletUrl(DashboardPageConfigUrlFactory.PortletConfigurationAdaptor accessor)
Description copied from interface: DashboardPageConfigUrlFactory
Returns a URL for RunPortlet action that will execute the given portlet configuration.

Specified by:
getRunPortletUrl in interface DashboardPageConfigUrlFactory
Parameters:
accessor - portlet configuration
Returns:
URL as String, never null

getDashboardBaseUrl

public String getDashboardBaseUrl(Long portletConfigurationId)
Description copied from interface: DashboardPageConfigUrlFactory
Returns a URL for dashboard configuration operation.

This method can be used to generate URL that does not require an operation to be specified. The operation can be appended to it.

Specified by:
getDashboardBaseUrl in interface DashboardPageConfigUrlFactory
Parameters:
portletConfigurationId - portlet configuration id
Returns:
URL as String, never null

getPortletOperationUrl

public String getPortletOperationUrl(Long portletId,
                                     String operationName)
Description copied from interface: DashboardPageConfigUrlFactory
Returns a URL for dashboard configuration operation.

This is used for operations such as 'left', 'right', 'up', 'down', 'first' and 'last'.

Specified by:
getPortletOperationUrl in interface DashboardPageConfigUrlFactory
Parameters:
portletId - portlet configuration id
operationName - operation name
Returns:
URL as String, never null

getAddPortletUrl

public String getAddPortletUrl()
Description copied from interface: DashboardPageConfigUrlFactory
Returns a URL for adding a portlet to the dashboard.

Specified by:
getAddPortletUrl in interface DashboardPageConfigUrlFactory
Returns:
the URL, never null.

getEditPortletUrl

public String getEditPortletUrl(Long portletConfigId)
Description copied from interface: DashboardPageConfigUrlFactory
Returns a URL for configuring portlets on the dashboard.

Specified by:
getEditPortletUrl in interface DashboardPageConfigUrlFactory
Parameters:
portletConfigId - the portlet to configure.
Returns:
the URL, never null.


Copyright © 2002-2008 Atlassian. All Rights Reserved.