Package com.broadleafcommerce.customer.web.endpoint

Class CustomerNoteEndpoint

java.lang.Object

com.broadleafcommerce.customer.web.endpoint.CustomerNoteEndpoint

@FrameworkRestController
@FrameworkMapping("/customers/{customerId}/customer-notes")
@DataRouteByExample(Customer.class)
public class CustomerNoteEndpoint
extends Object

Endpoint for management of CustomerNotes.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
CustomerNoteEndpoint(CustomerNoteService<CustomerNote> customerNoteService)

Method Summary

Modifier and Type	Method	Description
CustomerNote	createCustomerNote(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String customerId, CustomerNote customerNote)
void	deleteCustomerNote(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String customerId, String customerNoteId)
protected CustomerNoteService<CustomerNote>	getCustomerNoteService()
org.springframework.data.domain.Page<CustomerNote>	readAllCustomerNotes(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String customerId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
CustomerNote	readCustomerNoteById(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String customerId, String customerNoteId)

Methods inherited from class java.lang.Object

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

Field Detail

BASE_URI

public static final String BASE_URI

See Also:

Constant Field Values

Constructor Detail

CustomerNoteEndpoint

public CustomerNoteEndpoint(CustomerNoteService<CustomerNote> customerNoteService)

Method Detail

readAllCustomerNotes

@Policy(permissionRoots="CUSTOMER_NOTE")
@FrameworkGetMapping
public org.springframework.data.domain.Page<CustomerNote> readAllCustomerNotes(@ContextOperation
                                                                               com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                               @PathVariable("customerId")
                                                                               String customerId,
                                                                               cz.jirutka.rsql.parser.ast.Node filters,
                                                                               @PageableDefault(size=50)
                                                                               org.springframework.data.domain.Pageable page)

readCustomerNoteById

@Policy(permissionRoots="CUSTOMER_NOTE")
@FrameworkGetMapping("/{id}")
public CustomerNote readCustomerNoteById(@ContextOperation
                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                         @PathVariable("customerId")
                                         String customerId,
                                         @PathVariable("id")
                                         String customerNoteId)

createCustomerNote

@Policy(permissionRoots="CUSTOMER_NOTE")
@FrameworkPostMapping(consumes="application/json")
public CustomerNote createCustomerNote(@ContextOperation(CREATE)
                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                       @PathVariable("customerId")
                                       String customerId,
                                       @RequestBody
                                       CustomerNote customerNote)

deleteCustomerNote

@Policy(permissionRoots="CUSTOMER_NOTE")
@FrameworkDeleteMapping("/{id}")
public void deleteCustomerNote(@ContextOperation(DELETE)
                               com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                               @PathVariable("customerId")
                               String customerId,
                               @PathVariable("id")
                               String customerNoteId)

getCustomerNoteService

protected CustomerNoteService<CustomerNote> getCustomerNoteService()