1 package com.atlassian.plugin.web;
2
3 import java.util.List;
4 import java.util.Map;
5
6 /**
7 * A simple manager to provide sections of the web interface through plugins.
8 */
9 public interface WebInterfaceManager
10 {
11 /**
12 * @return True if there are any sections for the given location.
13 */
14 boolean hasSectionsForLocation(String location);
15
16 /**
17 * @return A list of all WebSectionModuleDescriptors for the given location.
18 */
19 List getSections(String location);
20
21 /**
22 * @return A list of all AbstractWebFragmentModuleDescriptor <i>viewable in a given context</i> in the given location.
23 */
24 List getDisplayableSections(String location, Map context);
25
26 /**
27 * @return A list of all WebItemModuleDescriptors for the given section.
28 */
29 List getItems(String section);
30
31 /**
32 * @return A list of all AbstractWebFragmentModuleDescriptor <i>viewable in a given context</i> in the given section.
33 */
34 List getDisplayableItems(String section, Map context);
35
36 /**
37 * Refresh the contents of the web interface manager.
38 */
39 void refresh();
40
41 /**
42 * @return The web fragment helper for this implementation.
43 */
44 WebFragmentHelper getWebFragmentHelper();
45 }