Package com.broadleafcommerce.menu.web.endpoint

Class MenuEndpoint

java.lang.Object

com.broadleafcommerce.menu.web.endpoint.MenuEndpoint

@FrameworkRestController
@FrameworkMapping("/menus")
@DataRouteByExample(Menu.class)
public class MenuEndpoint
extends Object

Author:

Phillip Verheyden (phillipuniverse), Samarth Dhruva (samarthd)

Field Summary

Fields

Modifier and Type	Field	Description
static String	MENUS_URI

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Menu	createMenu(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, Menu menu)
void	deleteMenu(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, 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<Menu>	readAllMenus(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String nameQuery, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
Menu	readMenu(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllMenuTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
Menu	replaceMenu(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, Menu menu)

Methods inherited from class java.lang.Object

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

Field Detail

MENUS_URI

public static final String MENUS_URI

See Also:

Constant Field Values

Constructor Detail

MenuEndpoint

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

Method Detail

readAllMenus

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

readMenu

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

createMenu

@Policy(permissionRoots="MENU")
@FrameworkPostMapping(consumes="application/json")
public Menu createMenu(@ContextOperation(CREATE)
                       com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                       @RequestBody
                       Menu menu)

replaceMenu

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

replaceAllMenuTranslations

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

deleteMenu

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

getMenuService

protected MenuService<Menu> getMenuService()

getMenuItemService

protected MenuItemService<MenuItem> getMenuItemService()

getTranslationEntityService

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