com.atlassian.jira.portal
Class PortletConfigurationManagerImpl

java.lang.Object
  extended by com.atlassian.jira.portal.PortletConfigurationManagerImpl
All Implemented Interfaces:
PortletConfigurationManager

public class PortletConfigurationManagerImpl
extends Object
implements PortletConfigurationManager


Constructor Summary
PortletConfigurationManagerImpl(PortletConfigurationStore portletConfigurationStore)
           
 
Method Summary
 PortletConfiguration add(Long pageId, String portletKey, Integer column, Integer row)
          Create a new portlet configuration 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.
 void deleteByProject(Project project)
          Removes all the portlet configurations for a project on any portal page.
 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.

deleteByProject

public void deleteByProject(Project project)
Description copied from interface: PortletConfigurationManager
Removes all the portlet configurations for a project on any portal page. This is used mainly when a project is deleted. This method will find all the portletConfigurations that make use of a project filter or the project directly, and delete them.

Specified by:
deleteByProject in interface PortletConfigurationManager
Parameters:
project - The project whose portlets will be deleted

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.

add

public PortletConfiguration add(Long pageId,
                                String portletKey,
                                Integer column,
                                Integer row)
Description copied from interface: PortletConfigurationManager
Create a new portlet configuration for the passed parameters.

Specified by:
add in interface PortletConfigurationManager
Parameters:
pageId - the portal page the configuration will belong to.
portletKey - the portal the configuration will be associated with.
column - the column location for the new configuration.
row - the row location for the new configuration.
Returns:
the new portlet configuration.

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

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.


Copyright © 2002-2009 Atlassian. All Rights Reserved.