public interface PortletConfigurationManager
PortletConfiguration
domain object.
It has a legacy name, but actually manages the Google Gadgets.
Modifier and Type | Method and Description |
---|---|
PortletConfiguration |
addDashBoardItem(Long portalPageId,
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)
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)
|
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.
|
List<PortletConfiguration> getByPortalPage(Long portalPageId)
PortletConfiguration
associated with the passed Portal Page.portalPageId
- the portal page to query.PortletConfiguration getByPortletId(Long portletId)
portletId
- the id of the portlet configuration to return.void delete(PortletConfiguration pc)
pc
- the portlet configuration to remove.void store(PortletConfiguration pc)
pc
- the portlet configuration to change.@Deprecated PortletConfiguration addGadget(Long portalPageId, Integer column, Integer row, URI gadgetXml, com.atlassian.gadgets.dashboard.Color color, Map<String,String> userPreferences)
addDashBoardItem(Long, Integer, Integer, io.atlassian.fugue.Option, com.atlassian.gadgets.dashboard.Color, java.util.Map, io.atlassian.fugue.Option)
instead. Since v6.4portalPageId
- 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.PortletConfiguration addDashBoardItem(Long portalPageId, 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)
PortletConfiguration
to the given PortalPage
for the passed 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 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.Copyright © 2002-2022 Atlassian. All Rights Reserved.