public interface PortletConfigurationStore
PortletConfiguration
domain object.Modifier and Type | Method and Description |
---|---|
PortletConfiguration |
addDashboardItem(Long pageId,
Long portletConfigurationId,
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)
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.
|
List<PortletConfiguration> getByPortalPage(Long portalPageId)
PortletConfiguration
objects for a given PortalPage
id.portalPageId
- The id of the page to retreive all configurations for.@Nullable PortletConfiguration getByPortletId(Long portletId)
PortletConfiguration
by its id.portletId
- The id of the portlet configuration.void delete(PortletConfiguration pc)
PortletConfiguration
.pc
- The PortletConfiguration to delete.void store(PortletConfiguration pc)
PortletConfiguration
.pc
- The PortletConfiguration to save.void updateGadgetPosition(Long gadgetId, int row, int column, Long dashboardId)
gadgetId
- The id of the gadget being updatedrow
- The new row value for this gadgetcolumn
- The new column value for this gadgetdashboardId
- The new parent dashboard id value for this gadgetvoid updateGadgetColor(Long gadgetId, com.atlassian.gadgets.dashboard.Color color)
gadgetId
- The id of the gadget being updatedcolor
- The new color value for this gadgetvoid updateUserPrefs(Long gadgetId, Map<String,String> userPrefs)
gadgetId
- The id of the gadget being updateduserPrefs
- The new userprefs to set for this gadget.@Deprecated PortletConfiguration addGadget(Long pageId, Long portletConfigurationId, Integer column, Integer row, URI gadgetXml, com.atlassian.gadgets.dashboard.Color color, Map<String,String> userPreferences)
PortletConfiguration
to given PortalPage. This should
be used to add a gadget.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 portletgadgetXml
- 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.addDashboardItem(Long, Long, Integer, Integer, com.atlassian.fugue.Option, com.atlassian.gadgets.dashboard.Color, java.util.Map, com.atlassian.fugue.Option)
instead. Since v6.4PortletConfiguration addDashboardItem(Long pageId, Long portletConfigurationId, 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)
PortletConfiguration
to given PortalPage. This should
be used to add a gadget.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 portletopenSocialSpecUri
- 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.EnclosedIterable<PortletConfiguration> getAllPortletConfigurations()
Copyright © 2002-2015 Atlassian. All Rights Reserved.