Interface MenuItemProvider
-
public interface MenuItemProvider
The
MenuItemProvider
provides connection points to the supervisor menu.SubMenuItem
can be added to the app menu and to the bottom of all other main menu items.The app menu is a special menu for apps. Apps can store menu items there. This is the preferred spot the other menu spots should only be used if necessary.
- Since:
- 10.0.34
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default java.util.List<SubMenuItem>
getAdministrationMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the administration menu.default java.util.List<SubMenuItem>
getAnalyticsMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the analytics menu.java.util.List<SubMenuItem>
getAppMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the app menu.default java.util.List<SubMenuItem>
getBacklogMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the backlog menu.default java.util.List<SubMenuItem>
getHelpMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the help menu.default java.util.List<SubMenuItem>
getReportsMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the reports menu.default java.util.List<SubMenuItem>
getSearchMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the search menu.
-
-
-
Method Detail
-
getBacklogMenuItems
default java.util.List<SubMenuItem> getBacklogMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the backlog menu. This menu entry point should only be used if necessary.- Parameters:
user
- the user to collect the menu items for- Returns:
- the list of backlog menu items
- Since:
- 10.0.34
-
getSearchMenuItems
default java.util.List<SubMenuItem> getSearchMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the search menu. This menu entry point should only be used if necessary.- Parameters:
user
- the user to collect the menu items for- Returns:
- the list of search menu items
- Since:
- 10.0.42
-
getAnalyticsMenuItems
default java.util.List<SubMenuItem> getAnalyticsMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the analytics menu. This menu entry point should only be used if necessary.- Parameters:
user
- the user to collect the menu items for- Returns:
- the list of analytics menu items
- Since:
- 10.0.34
-
getReportsMenuItems
default java.util.List<SubMenuItem> getReportsMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the reports menu. This menu entry point should only be used if necessary.- Parameters:
user
- the user to collect the menu items for- Returns:
- the list of backlog menu items
- Since:
- 10.0.34
-
getAdministrationMenuItems
default java.util.List<SubMenuItem> getAdministrationMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the administration menu. This menu entry point should only be used if necessary.- Parameters:
user
- the user to collect the menu items for- Returns:
- the list of administration menu items
- Since:
- 10.0.34
-
getHelpMenuItems
default java.util.List<SubMenuItem> getHelpMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the help menu. This menu entry point should only be used if necessary.- Parameters:
user
- the user to collect the menu items for- Returns:
- the list of help menu items
- Since:
- 10.0.34
-
getAppMenuItems
java.util.List<SubMenuItem> getAppMenuItems(User user)
This function will be called to collect allSubMenuItem
s to be stored in the end of the app menu.- Parameters:
user
- the user to collect the menu items for- Returns:
- the list of app menu items
- Since:
- 10.0.34
-
-