|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DashboardStateStore
Provides a means for looking up, updating and removing DashboardState
objects to/from the persistent
store.
Method Summary | |
---|---|
DashboardState |
findDashboardWithGadget(GadgetId gadgetId)
Retrieve the DashboardState for the dashboard containing the gadget whose identifier is gadgetID |
void |
remove(DashboardId id)
Removes the DashboardState identified by the DashboardId from the persistent data store. |
DashboardState |
retrieve(DashboardId id)
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. |
Method Detail |
---|
DashboardState retrieve(DashboardId id) throws DashboardNotFoundException, DashboardStateStoreException
DashboardState
with the DashboardId
from the data store.
id
- unique identifier of the DashboardState
object to retrieve
DashboardState
object corresponding to the DashboardId
DashboardNotFoundException
- thrown if there is no DashboardState
object with the given id
DashboardStateStoreException
- thrown if there is a problem when retrieving the DashboardState
from the persistent storeDashboardState update(DashboardState dashboardState, Iterable<DashboardChange> changes) throws DashboardStateStoreException
DashboardState
in the persistent data store, using the changes
passed in.
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 storevoid remove(DashboardId id) throws DashboardStateStoreException
DashboardState
identified by the DashboardId
from the persistent data store.
id
- unique identifier of the DashboardState
to be removed from the persistent data store
DashboardStateStoreException
- thrown if there is a problem when removing the DashboardState
from
the persistent data storeDashboardState findDashboardWithGadget(GadgetId gadgetId) throws DashboardNotFoundException
DashboardState
for the dashboard containing the gadget whose identifier is gadgetID
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 store
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |