com.atlassian.gadgets.dashboard

Interface DashboardItemModules

public interface DashboardItemModules

Method Summary

Modifier and Type	Method and Description
io.atlassian.fugue.Option<DashboardItemModuleDescriptor>	getDashboardItemForModuleKey(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey)
io.atlassian.fugue.Option<DashboardItemModuleDescriptor>	getDashboardItemModuleDescriptor(String uri) Returns an optional DashboardItemModuleDescriptor for a given OpenSocial gadget URI identifier.
Iterable<DashboardItemModuleDescriptor>	getDashboardItemsWithDirectoryDefinition() Returns all dashboard items which declared a specification.

Method Detail

getDashboardItemModuleDescriptor

io.atlassian.fugue.Option<DashboardItemModuleDescriptor> getDashboardItemModuleDescriptor(@Nonnull
                                                                                          String uri)

Returns an optional DashboardItemModuleDescriptor for a given OpenSocial gadget URI identifier. This may not be defined if no dashboard item module mapped to this URI can be found in the plugins system.

Parameters:

uri - of the specification to replace.

getDashboardItemsWithDirectoryDefinition

Iterable<DashboardItemModuleDescriptor> getDashboardItemsWithDirectoryDefinition()

Returns all dashboard items which declared a specification.

getDashboardItemForModuleKey

io.atlassian.fugue.Option<DashboardItemModuleDescriptor> getDashboardItemForModuleKey(@Nonnull
                                                                                      com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey)