com.atlassian.jira.portal

Interface PortletConfigurationStore

All Known Subinterfaces:

FlushablePortletConfigurationStore

All Known Implementing Classes:

CachingPortletConfigurationStore, OfbizPortletConfigurationStore

public interface PortletConfigurationStore

Store for the PortletConfiguration domain object.

Method Summary

Modifier and Type	Method and Description
PortletConfiguration	addDashboardItem(Long pageId, Long portletConfigurationId, Integer column, Integer row, io.atlassian.fugue.Option<URI> openSocialSpecUri, com.atlassian.gadgets.dashboard.Color color, Map<String,String> userPreferences, io.atlassian.fugue.Option<com.atlassian.plugin.ModuleCompleteKey> moduleKey) Creates and adds a new PortletConfiguration to given PortalPage.
PortletConfiguration	addGadget(Long pageId, Long portletConfigurationId, Integer column, Integer row, URI gadgetXml, com.atlassian.gadgets.dashboard.Color color, Map<String,String> userPreferences) Deprecated.
void	delete(PortletConfiguration pc) Deletes the given PortletConfiguration.
EnclosedIterable<PortletConfiguration>	getAllPortletConfigurations() Returns an iterable over all PortletConfigurations available in the database.
List<PortletConfiguration>	getByPortalPage(Long portalPageId) Get all PortletConfiguration objects for a given PortalPage id.
PortletConfiguration	getByPortletId(Long portletId) Gall a PortletConfiguration by its id.
void	store(PortletConfiguration pc) Saves the given PortletConfiguration.
void	updateGadgetColor(Long gadgetId, com.atlassian.gadgets.dashboard.Color color) Given a gadget, this method will update the color value for this gadget.
void	updateGadgetPosition(Long gadgetId, int row, int column, Long dashboardId) Given a gadget, this method will update it's row, column and parent dashboard id.
void	updateUserPrefs(Long gadgetId, Map<String,String> userPrefs) Given a gadget, this method updates all userprefs for this gadget.

Method Detail

getByPortalPage

List<PortletConfiguration> getByPortalPage(Long portalPageId)

Get all PortletConfiguration objects for a given PortalPage id.

Parameters:

portalPageId - The id of the page to retreive all configurations for.

Returns:

The configurations associated with the given page.

getByPortletId

@Nullable
PortletConfiguration getByPortletId(Long portletId)

Gall a PortletConfiguration by its id.

Parameters:

portletId - The id of the portlet configuration.

Returns:

The configuration of the given id or null.

delete

void delete(PortletConfiguration pc)

Deletes the given PortletConfiguration.

Parameters:

pc - The PortletConfiguration to delete.

store

void store(PortletConfiguration pc)

Saves the given PortletConfiguration.

Parameters:

pc - The PortletConfiguration to save.

updateGadgetPosition

void updateGadgetPosition(Long gadgetId,
                          int row,
                          int column,
                          Long dashboardId)

Given a gadget, this method will update it's row, column and parent dashboard id.

Parameters:

gadgetId - The id of the gadget being updated

row - The new row value for this gadget

column - The new column value for this gadget

dashboardId - The new parent dashboard id value for this gadget

updateGadgetColor

void updateGadgetColor(Long gadgetId,
                       com.atlassian.gadgets.dashboard.Color color)

Given a gadget, this method will update the color value for this gadget.

Parameters:

gadgetId - The id of the gadget being updated

color - The new color value for this gadget

updateUserPrefs

void updateUserPrefs(Long gadgetId,
                     Map<String,String> userPrefs)

Given a gadget, this method updates all userprefs for this gadget.

Parameters:

gadgetId - The id of the gadget being updated

userPrefs - The new userprefs to set for this gadget.

addGadget

@Deprecated
PortletConfiguration addGadget(Long pageId,
                                           Long portletConfigurationId,
                                           Integer column,
                                           Integer row,
                                           URI gadgetXml,
                                           com.atlassian.gadgets.dashboard.Color color,
                                           Map<String,String> userPreferences)

Deprecated.

Creates and adds a new PortletConfiguration to given PortalPage. This should be used to add a gadget.

Parameters:

pageId - The id of the page to add the configuration to.

portletConfigurationId - The id to use for adding the gadget. May be null for a generated id.

column - The column position of the portlet.

row - The row position of the portlet

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 PortletConfiguration with the id set. deprecated Use addDashboardItem(Long, Long, Integer, Integer, io.atlassian.fugue.Option, com.atlassian.gadgets.dashboard.Color, java.util.Map, io.atlassian.fugue.Option) instead. Since v6.4

addDashboardItem

PortletConfiguration addDashboardItem(Long pageId,
                                      Long portletConfigurationId,
                                      Integer column,
                                      Integer row,
                                      io.atlassian.fugue.Option<URI> openSocialSpecUri,
                                      com.atlassian.gadgets.dashboard.Color color,
                                      Map<String,String> userPreferences,
                                      io.atlassian.fugue.Option<com.atlassian.plugin.ModuleCompleteKey> moduleKey)

Creates and adds a new PortletConfiguration to given PortalPage. This should be used to add a gadget.

Parameters:

pageId - The id of the page to add the configuration to.

portletConfigurationId - The id to use for adding the gadget. 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 PortletConfiguration with the id set.

Since:

6.4

getAllPortletConfigurations

EnclosedIterable<PortletConfiguration> getAllPortletConfigurations()

Returns an iterable over all PortletConfigurations available in the database.

Returns:

iterable over all PortletConfigurations available in the database