Package com.broadleafcommerce.menu.web.endpoint

Class MenuHierarchyEndpoint

java.lang.Object

com.broadleafcommerce.menu.web.endpoint.MenuHierarchyEndpoint

@FrameworkRestController
@FrameworkMapping("/menu-hierarchy")
@DataRouteByExample(Menu.class)
public class MenuHierarchyEndpoint
extends Object

Endpoint for retrieving the navigation tree for a menu.

Author:

Samarth Dhruva (samarthd)

Field Summary

Fields

Modifier and Type	Field	Description
protected final MenuService<Menu>	menuService

Constructor Summary

Constructors

Constructor	Description
MenuHierarchyEndpoint(MenuService<Menu> menuService)

Method Summary

Modifier and Type	Method	Description
NavigableMenu	getNavigationTreeForMenu(String menuName, Integer depthLimit, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

menuService

protected final MenuService<Menu> menuService

Constructor Details

MenuHierarchyEndpoint

public MenuHierarchyEndpoint(MenuService<Menu> menuService)

Method Details

getNavigationTreeForMenu

@Policy(permissionRoots="MENU")
@FrameworkGetMapping
public NavigableMenu getNavigationTreeForMenu(@RequestParam("menuName")
 String menuName,
 @RequestParam @Nullable
 Integer depthLimit,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)