com.atlassian.jira.portal

Class PortletConfigurationManagerImpl

java.lang.Object

com.atlassian.jira.portal.PortletConfigurationManagerImpl

All Implemented Interfaces:

PortletConfigurationManager

public class PortletConfigurationManagerImpl
extends Object
implements PortletConfigurationManager

Constructor Summary

Constructors

Constructor and Description
PortletConfigurationManagerImpl(PortletConfigurationStore portletConfigurationStore)

Method Summary

Modifier and Type	Method and Description
PortletConfiguration	addDashBoardItem(Long portalPageId, Integer column, Integer row, com.atlassian.fugue.Option<URI> openSocialSpecUri, com.atlassian.gadgets.dashboard.Color color, Map<String,String> userPreferences, com.atlassian.fugue.Option<com.atlassian.plugin.ModuleCompleteKey> moduleKey) Create a new PortletConfiguration to the given PortalPage for the passed parameters.
PortletConfiguration	addGadget(Long portalPageId, Integer column, Integer row, URI gadgetXml, com.atlassian.gadgets.dashboard.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletConfigurationManagerImpl

public PortletConfigurationManagerImpl(PortletConfigurationStore portletConfigurationStore)

Method Detail

getByPortalPage

public List<PortletConfiguration> getByPortalPage(Long portalPageId)

Description copied from interface: PortletConfigurationManager

Get all the PortletConfiguration associated with the passed Portal Page.

Specified by:

getByPortalPage in interface PortletConfigurationManager

Parameters:

portalPageId - the portal page to query.

Returns:

a list of portlet configurations on the passed page.

getByPortletId

public PortletConfiguration getByPortletId(Long portletId)

Description copied from interface: PortletConfigurationManager

Get the passed portlet configuration.

Specified by:

getByPortletId in interface PortletConfigurationManager

Parameters:

portletId - the id of the portlet configuration to return.

Returns:

the porlet configuration identified by the passed id.

delete

public void delete(PortletConfiguration pc)

Description copied from interface: PortletConfigurationManager

Remove the passed portlet configuration.

Specified by:

delete in interface PortletConfigurationManager

Parameters:

pc - the portlet configuration to remove.

addGadget

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

Description copied from interface: PortletConfigurationManager

Create a new portlet configuration for the passed parameters.

Specified by:

addGadget in interface PortletConfigurationManager

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

addDashBoardItem

public PortletConfiguration addDashBoardItem(Long portalPageId,
                                             Integer column,
                                             Integer row,
                                             com.atlassian.fugue.Option<URI> openSocialSpecUri,
                                             com.atlassian.gadgets.dashboard.Color color,
                                             Map<String,String> userPreferences,
                                             com.atlassian.fugue.Option<com.atlassian.plugin.ModuleCompleteKey> moduleKey)

Description copied from interface: PortletConfigurationManager

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

Specified by:

addDashBoardItem in interface PortletConfigurationManager

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.

store

public void store(PortletConfiguration pc)

Description copied from interface: PortletConfigurationManager

Update the passed portlet configuration.

Specified by:

store in interface PortletConfigurationManager

Parameters:

pc - the portlet configuration to change.