Package com.broadleafcommerce.cart.web.endpoint

Class ItemListEndpoint<P extends com.broadleafcommerce.cart.client.domain.ItemList>

java.lang.Object

com.broadleafcommerce.cart.web.endpoint.ItemListEndpoint<P>

@FrameworkRestController
@FrameworkMapping
@DataRouteByExample(com.broadleafcommerce.cart.client.domain.ItemList.class)
public class ItemListEndpoint<P extends com.broadleafcommerce.cart.client.domain.ItemList>
extends Object

Endpoint for managing item lists.

Author:

Jacob Mitash

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_PATH
static final String	BULK_LIST

Constructor Summary

Constructors

Constructor	Description
ItemListEndpoint(ItemListService<P> itemListService)

Method Summary

Modifier and Type	Method	Description
P	create(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, P itemList)
void	delete(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
void	deleteLists(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Set<String> listIds)	Deprecated. Use deleteListsInBulk(ContextInfo, Set).
void	deleteListsInBulk(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Set<String> listIds)
protected ItemListService<P>	getItemListService()
P	readById(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, boolean hydrate)
org.springframework.data.domain.Page<P>	readByIds(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Collection<String> itemListIds, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
P	replace(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, P itemList)
P	update(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, P itemList)

Methods inherited from class java.lang.Object

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

Field Details

BASE_PATH

public static final String BASE_PATH

See Also:

• Constant Field Values

BULK_LIST

public static final String BULK_LIST

See Also:

• Constant Field Values

Constructor Details

ItemListEndpoint

public ItemListEndpoint(ItemListService<P> itemListService)

Method Details

readById

@Policy(permissionRoots="CART")
@FrameworkGetMapping("/item-lists/{id}")
public P readById(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable
 String id,
 @RequestParam(defaultValue="false")
 boolean hydrate)

readByIds

@Policy(permissionRoots="CART")
@FrameworkGetMapping(value="/item-lists",
                     params="itemListIds")
public org.springframework.data.domain.Page<P> readByIds(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam
 Collection<String> itemListIds,
 @PageableDefault(50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

create

@Policy(permissionRoots="CART")
@FrameworkPostMapping("/item-lists")
public P create(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 P itemList)

replace

@Policy(permissionRoots="CART")
@FrameworkPutMapping("/item-lists/{id}")
public P replace(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable
 String id,
 @RequestBody
 P itemList)

update

@Policy(permissionRoots="CART")
@FrameworkPatchMapping("/item-lists/{id}")
public P update(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable
 String id,
 @RequestBody
 P itemList)

delete

@Policy(permissionRoots="CART")
@FrameworkDeleteMapping("/item-lists/{id}")
public void delete(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable
 String id)

deleteLists

@Deprecated
@Policy(permissionRoots="CART")
@FrameworkDeleteMapping("/bulk-item-lists")
public void deleteLists(@ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam
 Set<String> listIds)

Deprecated.

Use deleteListsInBulk(ContextInfo, Set). This will allow much longer lists of IDs without worrying about whether the URL is too long and corrects the HTTP method semantics by using POST since we're not actually deleting a resource at the URL.

deleteListsInBulk

@Policy(permissionRoots="CART")
@FrameworkPostMapping(value="/bulk-item-lists/delete",
                      consumes="application/json")
public void deleteListsInBulk(@ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 Set<String> listIds)

getItemListService

protected ItemListService<P> getItemListService()