Package com.broadleafcommerce.cart.web.endpoint

Class CartNoteEndpoint

java.lang.Object

com.broadleafcommerce.cart.web.endpoint.CartNoteEndpoint

@FrameworkRestController
@FrameworkMapping("/carts/{cartId}/notes")
@DataRouteByKey("cart")
public class CartNoteEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
CartNoteEndpoint(CartNoteService<com.broadleafcommerce.cart.client.domain.CartNote> cartNoteService, CartService<com.broadleafcommerce.cart.client.domain.Cart> cartService)

Method Summary

Modifier and Type	Method	Description
com.broadleafcommerce.cart.client.domain.CartNote	create(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String cartId, com.broadleafcommerce.cart.client.domain.CartNote cartNote)
void	delete(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String cartId, String noteId)
com.broadleafcommerce.cart.client.domain.CartNote	getCartNoteById(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String cartId, String noteId)
protected CartNoteService<com.broadleafcommerce.cart.client.domain.CartNote>	getCartNoteService()
protected CartService<com.broadleafcommerce.cart.client.domain.Cart>	getCartService()
org.springframework.data.domain.Page<com.broadleafcommerce.cart.client.domain.CartNote>	readAll(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String cartId, boolean cartLevelOnly, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable)
com.broadleafcommerce.cart.client.domain.CartNote	replace(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String cartId, String noteId, com.broadleafcommerce.cart.client.domain.CartNote cartNote)
com.broadleafcommerce.cart.client.domain.CartNote	update(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String cartId, String noteId, com.broadleafcommerce.cart.client.domain.CartNote cartNote)
protected void	validateCartExists(String cartId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates that the cart with the cart id from CartNote.getCartId() exists.

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

CartNoteEndpoint

public CartNoteEndpoint(CartNoteService<com.broadleafcommerce.cart.client.domain.CartNote> cartNoteService,
 CartService<com.broadleafcommerce.cart.client.domain.Cart> cartService)

Method Details

create

@Policy(permissionRoots="CART_NOTE")
@FrameworkPostMapping
public com.broadleafcommerce.cart.client.domain.CartNote create(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable
 String cartId,
 @RequestBody
 com.broadleafcommerce.cart.client.domain.CartNote cartNote)

readAll

@Policy(permissionRoots="CART_NOTE")
@FrameworkGetMapping
public org.springframework.data.domain.Page<com.broadleafcommerce.cart.client.domain.CartNote> readAll(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable
 String cartId,
 @RequestParam(required=false,defaultValue="false")
 boolean cartLevelOnly,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50,sort="dateCreated",direction=DESC)
 org.springframework.data.domain.Pageable pageable)

getCartNoteById

@Policy(permissionRoots="CART_NOTE")
@FrameworkGetMapping("/{noteId}")
public com.broadleafcommerce.cart.client.domain.CartNote getCartNoteById(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable
 String cartId,
 @PathVariable
 String noteId)

replace

@Policy(permissionRoots="CART_NOTE")
@FrameworkPutMapping("/{noteId}")
public com.broadleafcommerce.cart.client.domain.CartNote replace(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable
 String cartId,
 @PathVariable
 String noteId,
 @RequestBody
 com.broadleafcommerce.cart.client.domain.CartNote cartNote)

update

@Policy(permissionRoots="CART_NOTE")
@FrameworkPatchMapping("/{noteId}")
public com.broadleafcommerce.cart.client.domain.CartNote update(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable
 String cartId,
 @PathVariable
 String noteId,
 @RequestBody
 com.broadleafcommerce.cart.client.domain.CartNote cartNote)

delete

@Policy(permissionRoots="CART_NOTE")
@FrameworkDeleteMapping("/{noteId}")
public void delete(@ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable
 String cartId,
 @PathVariable
 String noteId)

validateCartExists

protected void validateCartExists(String cartId,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Validates that the cart with the cart id from CartNote.getCartId() exists.

This is only used for read operations, other operations (create, update, and replace) are validated via CartNoteValidator.

Parameters:

cartId - the cart id to check

contextInfo - the contextInfo for the request

getCartNoteService

protected CartNoteService<com.broadleafcommerce.cart.client.domain.CartNote> getCartNoteService()

getCartService

protected CartService<com.broadleafcommerce.cart.client.domain.Cart> getCartService()