Package com.broadleafcommerce.adminnavigation.web.endpoint

Class NavMenuItemEndpoint

java.lang.Object

com.broadleafcommerce.adminnavigation.web.endpoint.NavMenuItemEndpoint

@FrameworkRestController
@FrameworkMapping("/admin-menu-items")
@DataRouteByExample(NavMenuItem.class)
public class NavMenuItemEndpoint
extends Object

Author:

Samarth Dhruva (samarthd)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MENU_ITEMS_URI
protected final MenuItemService<NavMenuItem>	menuItemService

Constructor Summary

Constructors

Constructor	Description
NavMenuItemEndpoint(MenuItemService<NavMenuItem> menuItemService)

Method Summary

Modifier and Type	Method	Description
NavMenuItem	createMenuItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, NavMenuItem navMenuItem)
void	deleteMenuItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
MenuItemAncestorList	getAncestors(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
org.springframework.data.domain.Page<NavMenuItem>	readAllMenuItems(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String labelQuery, boolean rootsOnly, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
org.springframework.data.domain.Page<NavMenuItem>	readChildrenOfMenuItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
NavMenuItem	readMenuItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
NavMenuItem	replaceMenuItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, NavMenuItem navMenuItem)

Methods inherited from class java.lang.Object

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

Field Details

MENU_ITEMS_URI

public static final String MENU_ITEMS_URI

See Also:

• Constant Field Values

menuItemService

protected final MenuItemService<NavMenuItem> menuItemService

Constructor Details

NavMenuItemEndpoint

public NavMenuItemEndpoint(MenuItemService<NavMenuItem> menuItemService)

Method Details

readAllMenuItems

@Policy(permissionRoots="ADMIN_MENU")
@FrameworkGetMapping
public org.springframework.data.domain.Page<NavMenuItem> readAllMenuItems(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestParam(value="q",required=false)
 String labelQuery,
 @RequestParam(value="rootsOnly",required=false,defaultValue="false")
 boolean rootsOnly,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

readMenuItem

@Policy(permissionRoots="ADMIN_MENU")
@FrameworkGetMapping("/{id}")
public NavMenuItem readMenuItem(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

createMenuItem

@Policy(permissionRoots="ADMIN_MENU")
@FrameworkPostMapping(consumes="application/json")
public NavMenuItem createMenuItem(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 NavMenuItem navMenuItem)

replaceMenuItem

@Policy(permissionRoots="ADMIN_MENU")
@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
public NavMenuItem replaceMenuItem(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id,
 @RequestBody
 NavMenuItem navMenuItem)

deleteMenuItem

@Policy(permissionRoots="ADMIN_MENU")
@FrameworkDeleteMapping("/{id}")
public void deleteMenuItem(@ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

getAncestors

@FrameworkGetMapping("/{id}/ancestors")
@Policy(permissionRoots="ADMIN_MENU")
public MenuItemAncestorList getAncestors(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id)

readChildrenOfMenuItem

@Policy(permissionRoots="ADMIN_MENU")
@FrameworkGetMapping("/{id}/children")
public org.springframework.data.domain.Page<NavMenuItem> readChildrenOfMenuItem(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)