|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use DashboardId | |
|---|---|
| com.atlassian.gadgets.dashboard | This package contains the main APIs for interacting with dashboards and gadgets. |
| com.atlassian.gadgets.dashboard.internal | |
| com.atlassian.gadgets.dashboard.internal.impl | |
| com.atlassian.gadgets.dashboard.internal.rest | Interfaces and classes used to implement dashboards and their gadgets as REST resources. |
| com.atlassian.gadgets.dashboard.internal.rest.representations | |
| com.atlassian.gadgets.dashboard.spi | Contains the service provider interfaces (SPIs) that host applications must implement in order to use the dashboard plugin(s). |
| com.atlassian.gadgets.refimpl | Provides an implementation of the SPI for the refapp. |
| Uses of DashboardId in com.atlassian.gadgets.dashboard |
|---|
| Methods in com.atlassian.gadgets.dashboard that return DashboardId | |
|---|---|
DashboardId |
DashboardTab.getDashboardId()
|
DashboardId |
DashboardNotFoundException.getDashboardId()
|
DashboardId |
DashboardState.getId()
Returns the unique identifier, represented by a DashboardId, for the dashboard's state. |
static DashboardId |
DashboardId.valueOf(String id)
Convert the String value to a DashboardId object. |
| Methods in com.atlassian.gadgets.dashboard with parameters of type DashboardId | |
|---|---|
static DashboardState.TitleBuilder |
DashboardState.dashboard(DashboardId id)
Factory method to create a new builder which can be used to create DashboardState objects. |
DashboardState |
DashboardService.get(DashboardId id,
String username)
Fetch the DashboardState if the user has permission. |
| Constructors in com.atlassian.gadgets.dashboard with parameters of type DashboardId | |
|---|---|
DashboardNotFoundException(DashboardId id)
|
|
DashboardTab(DashboardId dashboardId,
String title,
URI tabUri)
|
|
| Uses of DashboardId in com.atlassian.gadgets.dashboard.internal |
|---|
| Methods in com.atlassian.gadgets.dashboard.internal that return DashboardId | |
|---|---|
DashboardId |
DashboardRepository.findDashboardByGadgetId(GadgetId gadgetId)
|
DashboardId |
Tab.getDashboardId()
|
DashboardId |
Dashboard.getId()
|
| Methods in com.atlassian.gadgets.dashboard.internal with parameters of type DashboardId | |
|---|---|
String |
DashboardUrlBuilder.buildDashboardDirectoryUrl(DashboardId dashboardId)
Returns a URL that can be used to post a new gadget to the directory. |
String |
DashboardUrlBuilder.buildDashboardLayoutUrl(DashboardId dashboardId)
Returns the URL to the layout resource of a dashboard. |
String |
DashboardUrlBuilder.buildDashboardResourceUrl(DashboardId dashboardId)
Returns a URL that can be used to access the Dashboard resource, to post new gadgets. |
String |
DashboardUrlBuilder.buildDashboardUrl(DashboardId dashboardId)
Returns the URL to the dashboard container. |
String |
DashboardUrlBuilder.buildGadgetColorUrl(DashboardId dashboardId,
GadgetId gadgetId)
Returns the URL to the color resource of a gadget. |
String |
DashboardUrlBuilder.buildGadgetUrl(DashboardId dashboardId,
GadgetId gadgetId)
Returns the URL to a gadget resource on a dashboard. |
String |
DashboardUrlBuilder.buildGadgetUserPrefsUrl(DashboardId dashboardId,
GadgetId gadgetId)
Returns the URL to the user prefs resource of a gadget. |
Iterable<WebItemFinder.WebItem> |
DashboardWebItemFinder.findDashboardMenuItems(DashboardId dashboardId,
String username)
|
Iterable<WebItemFinder.WebItem> |
DashboardWebItemFinder.findDashboardToolsMenuItems(DashboardId dashboardId,
String username)
|
Dashboard |
DashboardRepository.get(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext)
|
| Uses of DashboardId in com.atlassian.gadgets.dashboard.internal.impl |
|---|
| Methods in com.atlassian.gadgets.dashboard.internal.impl that return DashboardId | |
|---|---|
DashboardId |
DashboardRepositoryImpl.findDashboardByGadgetId(GadgetId gadgetId)
|
DashboardId |
TabImpl.getDashboardId()
|
DashboardId |
DashboardImpl.getId()
|
| Methods in com.atlassian.gadgets.dashboard.internal.impl with parameters of type DashboardId | |
|---|---|
String |
DashboardUrlBuilderImpl.buildDashboardDirectoryUrl(DashboardId dashboardId)
|
String |
DashboardUrlBuilderImpl.buildDashboardLayoutUrl(DashboardId dashboardId)
|
String |
DashboardUrlBuilderImpl.buildDashboardResourceUrl(DashboardId dashboardId)
|
String |
DashboardUrlBuilderImpl.buildDashboardUrl(DashboardId dashboardId)
|
String |
DashboardUrlBuilderImpl.buildGadgetColorUrl(DashboardId dashboardId,
GadgetId gadgetId)
|
String |
DashboardUrlBuilderImpl.buildGadgetUrl(DashboardId dashboardId,
GadgetId gadgetId)
|
String |
DashboardUrlBuilderImpl.buildGadgetUserPrefsUrl(DashboardId dashboardId,
GadgetId gadgetId)
|
Dashboard |
DashboardRepositoryImpl.get(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext)
|
DashboardState |
DashboardServiceImpl.get(DashboardId id,
String username)
|
void |
TransactionalDashboardStateStoreImpl.remove(DashboardId dashboardId)
|
DashboardState |
TransactionalDashboardStateStoreImpl.retrieve(DashboardId dashboardId)
|
| Uses of DashboardId in com.atlassian.gadgets.dashboard.internal.rest |
|---|
| Methods in com.atlassian.gadgets.dashboard.internal.rest with parameters of type DashboardId | |
|---|---|
javax.ws.rs.core.Response |
AddGadgetHandler.addGadget(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
String gadgetUrl)
Adds the specified gadget to the specified dashboard. |
javax.ws.rs.core.Response |
AddGadgetHandlerImpl.addGadget(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
String gadgetUrl)
|
javax.ws.rs.core.Response |
AddGadgetHandler.addGadget(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
String gadgetUrl,
DashboardState.ColumnIndex columnIndex)
Adds the specified gadget to the specified dashboard in the specified column. |
javax.ws.rs.core.Response |
AddGadgetHandlerImpl.addGadget(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
String gadgetUrl,
DashboardState.ColumnIndex columnIndex)
|
javax.ws.rs.core.Response |
DashboardResource.addGadget(DashboardId dashboardId,
javax.servlet.http.HttpServletRequest request,
Reader jsonContent)
Adds a gadget to a dashboard, returning the new gadget's entity representation if successful. |
javax.ws.rs.core.Response |
GadgetResource.changeGadgetColor(DashboardId dashboardId,
GadgetId gadgetId,
javax.servlet.http.HttpServletRequest request,
String entity)
Changes the specified gadget's color in response to a PUT request. |
javax.ws.rs.core.Response |
GadgetResource.changeGadgetColorViaPOST(String method,
DashboardId dashboardId,
GadgetId gadgetId,
javax.servlet.http.HttpServletRequest request,
String entity)
Forwards POST requests (coming from Ajax or web browsers) to the PUT handler for color changing. |
javax.ws.rs.core.Response |
ChangeLayoutHandlerImpl.changeLayout(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
org.json.JSONObject newLayout)
|
javax.ws.rs.core.Response |
ChangeLayoutHandler.changeLayout(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
org.json.JSONObject newLayout)
Attempts to change the layout of the specified dashboard. |
javax.ws.rs.core.Response |
DashboardResource.changeLayoutViaPOST(DashboardId dashboardId,
javax.servlet.http.HttpServletRequest request,
String entity)
Changes the existing layout of the specified dashboard in response to a POST request. |
javax.ws.rs.core.Response |
DashboardResource.changeLayoutViaPUT(DashboardId dashboardId,
javax.servlet.http.HttpServletRequest request,
String entity)
Changes the existing layout of the specified dashboard in response to a PUT request. |
javax.ws.rs.core.Response |
GadgetResource.deleteGadget(DashboardId dashboardId,
GadgetId gadgetId,
javax.servlet.http.HttpServletRequest request)
Deletes the specified gadget from the specified dashboard when invoked as a DELETE request. |
javax.ws.rs.core.Response |
DeleteGadgetHandler.deleteGadget(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
GadgetId gadgetId)
Removes the specified gadget from the specified dashboard. |
javax.ws.rs.core.Response |
DeleteGadgetHandlerImpl.deleteGadget(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
GadgetId gadgetId)
|
javax.ws.rs.core.Response |
GadgetResource.deleteOrMoveGadgetViaPost(String method,
DashboardId dashboardId,
GadgetId gadgetId,
javax.servlet.http.HttpServletRequest request)
Deletes or moves the specified gadget from the specified dashboard when invoked as a POST request. |
javax.ws.rs.core.Response |
DashboardResource.getDashboard(DashboardId dashboardId,
javax.servlet.http.HttpServletRequest request)
|
javax.ws.rs.core.Response |
DashboardResource.getNumGadgets(DashboardId dashboardId,
javax.servlet.http.HttpServletRequest request)
|
javax.ws.rs.core.Response |
GadgetResource.getRenderedGadget(DashboardId dashboardId,
GadgetId gadgetId,
javax.servlet.http.HttpServletRequest request)
Returns a Gadget's JSON or XMl representation. |
javax.ws.rs.core.Response |
AddGadgetHandler.moveGadget(DashboardId targetDashboardId,
GadgetId gadgetId,
DashboardId sourceDashboardId,
DashboardState.ColumnIndex columnIndex,
int rowIndexAsInt,
GadgetRequestContext gadgetRequestContext)
Moves the gadget specified by id from the source dashboard to the target dashboard. |
javax.ws.rs.core.Response |
AddGadgetHandlerImpl.moveGadget(DashboardId targetDashboardId,
GadgetId gadgetId,
DashboardId sourceDashboardId,
DashboardState.ColumnIndex columnIndex,
int rowIndex,
GadgetRequestContext gadgetRequestContext)
|
javax.ws.rs.core.Response |
GadgetResource.moveGadget(DashboardId targetDashboardId,
GadgetId gadgetId,
javax.servlet.http.HttpServletRequest request)
Moves the specified gadget to the specified dashboard. |
javax.ws.rs.core.Response |
ChangeGadgetColorHandlerImpl.setGadgetColor(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
GadgetId gadgetId,
Color color)
|
javax.ws.rs.core.Response |
ChangeGadgetColorHandler.setGadgetColor(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
GadgetId gadgetId,
Color color)
Sets the color of the specified gadget to the specified color. |
javax.ws.rs.core.Response |
UpdateGadgetUserPrefsHandlerImpl.updateUserPrefs(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
GadgetId gadgetId,
Map<String,String> prefs)
|
javax.ws.rs.core.Response |
UpdateGadgetUserPrefsHandler.updateUserPrefs(DashboardId dashboardId,
GadgetRequestContext gadgetRequestContext,
GadgetId gadgetId,
Map<String,String> prefs)
Changes the user prefs on the specified gadget and dashboard to the values supplied by the query. |
javax.ws.rs.core.Response |
GadgetResource.updateUserPrefsViaPOST(String method,
DashboardId dashboardId,
GadgetId gadgetId,
javax.servlet.http.HttpServletRequest request,
String entity)
Forwards POST requests (coming from Ajax or web browsers) to the PUT handler for user pref changes. |
javax.ws.rs.core.Response |
GadgetResource.updateUserPrefsViaPUT(DashboardId dashboardId,
GadgetId gadgetId,
javax.servlet.http.HttpServletRequest request,
String entity)
Updates the user prefs of the specified gadget. |
| Uses of DashboardId in com.atlassian.gadgets.dashboard.internal.rest.representations |
|---|
| Methods in com.atlassian.gadgets.dashboard.internal.rest.representations with parameters of type DashboardId | |
|---|---|
GadgetRepresentation |
RepresentationFactory.createGadgetRepresentation(DashboardId dashboardId,
Gadget gadget,
GadgetRequestContext gadgetRequestContext,
boolean writable,
DashboardState.ColumnIndex column)
Given a Gadget, this creates a new JAXB gadget representation |
GadgetRepresentation |
RepresentationFactoryImpl.createGadgetRepresentation(DashboardId dashboardId,
Gadget gadget,
GadgetRequestContext gadgetRequestContext,
boolean writable,
DashboardState.ColumnIndex column)
|
| Uses of DashboardId in com.atlassian.gadgets.dashboard.spi |
|---|
| Methods in com.atlassian.gadgets.dashboard.spi with parameters of type DashboardId | |
|---|---|
boolean |
DashboardPermissionService.isReadableBy(DashboardId dashboardId,
String username)
Returns true if the user identified by username has permission to view the dashboard identified
by the DashboardId, false otherwise. |
boolean |
DashboardPermissionService.isWritableBy(DashboardId dashboardId,
String username)
Returns true if the user identified by username has permission to modify the dashboard identified
by the DashboardId, false otherwise. |
void |
DashboardStateStore.remove(DashboardId id)
Removes the DashboardState identified by the DashboardId from the persistent data store. |
DashboardState |
DashboardStateStore.retrieve(DashboardId id)
Retrieve the DashboardState with the DashboardId from the data store. |
| Uses of DashboardId in com.atlassian.gadgets.refimpl |
|---|
| Methods in com.atlassian.gadgets.refimpl with parameters of type DashboardId | |
|---|---|
boolean |
PermissionServiceImpl.isReadableBy(DashboardId dashboardId,
String username)
|
boolean |
PermissionServiceImpl.isWritableBy(DashboardId dashboardId,
String username)
|
void |
PluginSettingsDashboardStateStore.remove(DashboardId dashboardId)
|
DashboardState |
PluginSettingsDashboardStateStore.retrieve(DashboardId dashboardId)
|
|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||