|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletConfigurationStore
Store for the PortletConfiguration
domain object.
Method Summary | |
---|---|
PortletConfiguration |
addGadget(java.lang.Long pageId,
java.lang.Long portletConfigurationId,
java.lang.Integer column,
java.lang.Integer row,
java.net.URI gadgetXml,
com.atlassian.gadgets.dashboard.Color color,
java.util.Map<java.lang.String,java.lang.String> userPreferences)
Creates and adds a new PortletConfiguration to given PortalPage. |
PortletConfiguration |
addLegacyPortlet(java.lang.Long pageId,
java.lang.Long portletConfigurationId,
java.lang.Integer column,
java.lang.Integer row,
java.net.URI gadgetXml,
com.atlassian.gadgets.dashboard.Color color,
java.util.Map<java.lang.String,java.lang.String> userPreferences,
java.lang.String portletKey)
Creates and adds a new PortletConfiguration to given PortalPage. |
void |
delete(PortletConfiguration pc)
Deletes the given PortletConfiguration . |
EnclosedIterable<PortletConfiguration> |
getAllPortletConfigurations()
Returns an iterable over all PortletConfigurations available in the database. |
java.util.List<PortletConfiguration> |
getByPortalPage(java.lang.Long portalPageId)
Get all PortletConfiguration objects for a given PortalPage id. |
PortletConfiguration |
getByPortletId(java.lang.Long portletId)
Gall a PortletConfiguration by its id. |
void |
store(PortletConfiguration pc)
Saves the given PortletConfiguration . |
void |
updateGadgetColor(java.lang.Long gadgetId,
com.atlassian.gadgets.dashboard.Color color)
Given a gadget, this method will update the color value for this gadget. |
void |
updateGadgetPosition(java.lang.Long gadgetId,
int row,
int column,
java.lang.Long dashboardId)
Given a gadget, this method will update it's row, column and parent dashboard id. |
void |
updateUserPrefs(java.lang.Long gadgetId,
java.util.Map<java.lang.String,java.lang.String> userPrefs)
Given a gadget, this method updates all userprefs for this gadget. |
Method Detail |
---|
java.util.List<PortletConfiguration> getByPortalPage(java.lang.Long portalPageId)
PortletConfiguration
objects for a given PortalPage
id.
portalPageId
- The id of the page to retreive all configurations for.
PortletConfiguration getByPortletId(java.lang.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(java.lang.Long gadgetId, int row, int column, java.lang.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(java.lang.Long gadgetId, com.atlassian.gadgets.dashboard.Color color)
gadgetId
- The id of the gadget being updatedcolor
- The new color value for this gadgetvoid updateUserPrefs(java.lang.Long gadgetId, java.util.Map<java.lang.String,java.lang.String> userPrefs)
gadgetId
- The id of the gadget being updateduserPrefs
- The new userprefs to set for this gadget.PortletConfiguration addGadget(java.lang.Long pageId, java.lang.Long portletConfigurationId, java.lang.Integer column, java.lang.Integer row, java.net.URI gadgetXml, com.atlassian.gadgets.dashboard.Color color, java.util.Map<java.lang.String,java.lang.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. This will correspond to 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 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.
PortletConfiguration addLegacyPortlet(java.lang.Long pageId, java.lang.Long portletConfigurationId, java.lang.Integer column, java.lang.Integer row, java.net.URI gadgetXml, com.atlassian.gadgets.dashboard.Color color, java.util.Map<java.lang.String,java.lang.String> userPreferences, java.lang.String portletKey)
PortletConfiguration
to given PortalPage. This should
be used to add a legacy gadget only!
pageId
- The id of the page to add the configuration to.portletConfigurationId
- The id to use for adding the gadget. This will correspond to 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 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.portletKey
- The portletKey of the old portlet.
EnclosedIterable<PortletConfiguration> getAllPortletConfigurations()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |