public class

PortletConfigurationManagerImpl

extends Object
implements PortletConfigurationManager
java.lang.Object
   ↳ com.atlassian.jira.portal.PortletConfigurationManagerImpl

Summary

Public Constructors
PortletConfigurationManagerImpl(PortletConfigurationStore portletConfigurationStore)
Public Methods
PortletConfiguration addDashBoardItem(Long portalPageId, Integer column, Integer row, Option<URI> openSocialSpecUri, Color color, Map<String, String> userPreferences, Option<ModuleCompleteKey> moduleKey)
Create a new PortletConfiguration to the given PortalPage for the passed parameters.
PortletConfiguration addGadget(Long portalPageId, Integer column, Integer row, URI gadgetXml, Color color, Map<String, String> userPreferences)
Create a new portlet configuration for the passed parameters.
void delete(PortletConfiguration pc)
Remove the passed portlet configuration.
List<PortletConfiguration> getByPortalPage(Long portalPageId)
Get all the PortletConfiguration associated with the passed Portal Page.
PortletConfiguration getByPortletId(Long portletId)
Get the passed portlet configuration.
void store(PortletConfiguration pc)
Update the passed portlet configuration.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.portal.PortletConfigurationManager

Public Constructors

public PortletConfigurationManagerImpl (PortletConfigurationStore portletConfigurationStore)

Public Methods

public PortletConfiguration addDashBoardItem (Long portalPageId, Integer column, Integer row, Option<URI> openSocialSpecUri, Color color, Map<String, String> userPreferences, Option<ModuleCompleteKey> moduleKey)

Create a new PortletConfiguration to the given PortalPage for the passed parameters.

Parameters
portalPageId the portal page the configuration will belong to.* com.atlassian.jira.dashboard.JiraGadgetStateFactory#createGadgetState(java.net.URI)}. May be null for a generated id.
column The column position of the portlet.
row The row position of the portlet
openSocialSpecUri A URI specifying the location of the gadget XML. May be an empty option if this is a legacy portlet or dashboard item without uri replacement.
color The chrome color for the gadget.
userPreferences A map of key -> value user preference pairs used to store gadget configuration.
moduleKey A complete module key of dashboard items.
Returns
  • The new portlet configuration.

public PortletConfiguration addGadget (Long portalPageId, Integer column, Integer row, URI gadgetXml, Color color, Map<String, String> userPreferences)

Create a new portlet configuration for the passed parameters.

Parameters
portalPageId the portal page the configuration will belong to.
column the column location for the new configuration.
row the row location for the new configuration.
gadgetXml A URI specifying the location of the gadget XML. May be null if this is a legacy portlet.
color The chrome color for the gadget.
userPreferences A map of key -> value user preference pairs used to store gadget configuration.
Returns
  • the new portlet configuration

public void delete (PortletConfiguration pc)

Remove the passed portlet configuration.

Parameters
pc the portlet configuration to remove.

public List<PortletConfiguration> getByPortalPage (Long portalPageId)

Get all the PortletConfiguration associated with the passed Portal Page.

Parameters
portalPageId the portal page to query.
Returns
  • a list of portlet configurations on the passed page.

public PortletConfiguration getByPortletId (Long portletId)

Get the passed portlet configuration.

Parameters
portletId the id of the portlet configuration to return.
Returns
  • the porlet configuration identified by the passed id.

public void store (PortletConfiguration pc)

Update the passed portlet configuration.

Parameters
pc the portlet configuration to change.