|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.gadgets.refimpl.PluginSettingsDashboardStateStore
public class PluginSettingsDashboardStateStore
Constructor Summary | |
---|---|
PluginSettingsDashboardStateStore(com.atlassian.sal.api.pluginsettings.PluginSettingsFactory pluginSettingsFactory)
|
Method Summary | |
---|---|
DashboardState |
findDashboardWithGadget(GadgetId gadgetId)
Retrieve the DashboardState for the dashboard containing the gadget whose identifier is gadgetID |
void |
remove(DashboardId dashboardId)
Removes the DashboardState identified by the DashboardId from the persistent data store. |
DashboardState |
retrieve(DashboardId dashboardId)
Retrieve the DashboardState with the DashboardId from the data store. |
DashboardState |
update(DashboardState dashboardState,
Iterable<DashboardChange> changes)
Update the stored DashboardState in the persistent data store, using the changes passed in. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PluginSettingsDashboardStateStore(com.atlassian.sal.api.pluginsettings.PluginSettingsFactory pluginSettingsFactory)
Method Detail |
---|
public DashboardState retrieve(DashboardId dashboardId)
DashboardStateStore
DashboardState
with the DashboardId
from the data store.
retrieve
in interface DashboardStateStore
dashboardId
- unique identifier of the DashboardState
object to retrieve
DashboardState
object corresponding to the DashboardId
public DashboardState findDashboardWithGadget(GadgetId gadgetId) throws DashboardNotFoundException
DashboardStateStore
DashboardState
for the dashboard containing the gadget whose identifier is gadgetID
findDashboardWithGadget
in interface DashboardStateStore
gadgetId
- the identifier of the gadget
DashboardState
object for the dashboard containing the gadget
DashboardNotFoundException
- thrown if there is a problem retrieving the DashboardState
from the persistent storepublic DashboardState update(DashboardState dashboardState, Iterable<DashboardChange> changes) throws DashboardStateStoreException
DashboardStateStore
DashboardState
in the persistent data store, using the changes
passed in.
update
in interface DashboardStateStore
dashboardState
- the DashboardState
to update in the persistent data storechanges
- the changes to the dashboard that should be applied
DashboardState
so that it can be verified that the state we tried to store
is the actual state that is in the store
DashboardStateStoreException
- thrown if there is a problem when updating the DashboardState
in
the persistent data storepublic void remove(DashboardId dashboardId)
DashboardStateStore
DashboardState
identified by the DashboardId
from the persistent data store.
remove
in interface DashboardStateStore
dashboardId
- unique identifier of the DashboardState
to be removed from the persistent data store
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |