Package com.broadleafcommerce.menu.web.endpoint

Class MenuItemEndpoint

java.lang.Object

com.broadleafcommerce.menu.web.endpoint.MenuItemEndpoint

@FrameworkRestController
@FrameworkMapping("/menus/{menuId}/menu-items")
@DataRouteByExample(MenuItem.class)
public class MenuItemEndpoint
extends Object

Author:

Samarth Dhruva (samarthd)

Field Summary

Fields

Modifier and Type	Field	Description
static String	MENU_ITEMS_URI

Constructor Summary

Constructors

Constructor	Description
MenuItemEndpoint(MenuItemService<MenuItem> menuItemService, MenuService<Menu> menuService, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Summary

Modifier and Type	Method	Description
protected void	assertMenuIsParentOfItem(Menu menu, MenuItem menuItem)
MenuItem	createMenuItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String parentMenuId, MenuItem menuItem)
void	deleteMenuItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String parentMenuId, String id)
MenuItemAncestorList	getAncestors(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String parentMenuId, String id)
protected MenuItemService<MenuItem>	getMenuItemService()
protected MenuService<Menu>	getMenuService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
org.springframework.data.domain.Page<MenuItem>	readAllMenuItems(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String parentMenuId, String labelQuery, boolean rootsOnly, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
org.springframework.data.domain.Page<MenuItem>	readChildrenOfMenuItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String parentMenuId, String id)
MenuItem	readMenuItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String parentMenuId, String id)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllMenuItemTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String parentMenuId, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
MenuItem	replaceMenuItem(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String parentMenuId, String id, MenuItem menuItem)
protected List<MenuItem>	sortItems(List<MenuItem> toBeSorted)

Methods inherited from class java.lang.Object

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

Field Detail

MENU_ITEMS_URI

public static final String MENU_ITEMS_URI

See Also:

Constant Field Values

Constructor Detail

MenuItemEndpoint

public MenuItemEndpoint(MenuItemService<MenuItem> menuItemService,
                        MenuService<Menu> menuService,
                        com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Detail

readAllMenuItems

@Policy(permissionRoots="MENU")
@FrameworkGetMapping
public org.springframework.data.domain.Page<MenuItem> readAllMenuItems(@ContextOperation(READ)
                                                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                                                                       @PathVariable("menuId")
                                                                       String parentMenuId,
                                                                       @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,sort="displayOrder",direction=ASC)
                                                                       org.springframework.data.domain.Pageable page)

readMenuItem

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

createMenuItem

@Policy(permissionRoots="MENU")
@FrameworkPostMapping(consumes="application/json")
public MenuItem createMenuItem(@ContextOperation(CREATE)
                               com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                               @PathVariable("menuId")
                               String parentMenuId,
                               @RequestBody
                               MenuItem menuItem)

replaceMenuItem

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

replaceAllMenuItemTranslations

@FrameworkPutMapping(value="/{id}/translations/{locale}",
                     consumes="application/json")
@Policy(permissionRoots="MENU")
public com.broadleafcommerce.translation.service.dto.TranslationsPayload replaceAllMenuItemTranslations(@ContextOperation(UPDATE)
                                                                                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                                        @PathVariable("menuId")
                                                                                                        String parentMenuId,
                                                                                                        @PathVariable("id")
                                                                                                        String id,
                                                                                                        @PathVariable("locale")
                                                                                                        Locale locale,
                                                                                                        @RequestBody
                                                                                                        com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)

deleteMenuItem

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

readChildrenOfMenuItem

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

getAncestors

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

sortItems

protected List<MenuItem> sortItems(List<MenuItem> toBeSorted)

assertMenuIsParentOfItem

protected void assertMenuIsParentOfItem(@NonNull
                                        Menu menu,
                                        @NonNull
                                        MenuItem menuItem)

getMenuItemService

protected MenuItemService<MenuItem> getMenuItemService()

getMenuService

protected MenuService<Menu> getMenuService()

getTranslationEntityService

protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> getTranslationEntityService()