Package com.broadleafcommerce.order.web.endpoint

Class OrderFulfillmentNoteEndpoint

java.lang.Object

com.broadleafcommerce.order.web.endpoint.OrderFulfillmentNoteEndpoint

@FrameworkRestController
@FrameworkMapping("/order-fulfillments/{orderFulfillmentId}/notes")
@DataRouteByExample(OrderFulfillmentNote.class)
public class OrderFulfillmentNoteEndpoint
extends Object

Endpoint for management of OrderFulfillmentNotes.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
OrderFulfillmentNoteEndpoint(OrderFulfillmentNoteService<OrderFulfillmentNote> orderFulfillmentNoteService, OrderFulfillmentService<com.broadleafcommerce.order.client.domain.OrderFulfillment> orderFulfillmentService)

Method Summary

Modifier and Type	Method	Description
OrderFulfillmentNote	createOrderFulfillmentNote(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String orderFulfillmentId, OrderFulfillmentNote orderFulfillmentNote)
void	deleteOrderFulfillmentNote(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String orderFulfillmentId, String orderFulfillmentNoteId)
protected OrderFulfillmentNote	ensureNoteBelongsToOrderFulfillmentAndReturn(@NonNull String orderFulfillmentId, @NonNull String orderFulfillmentNoteId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Ensures that the OrderFulfillmentNote is associated with the specified order fulfillment ID.
protected void	ensureOrderFulfillmentExists(@NonNull String orderFulfillmentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Ensures that the OrderFulfillment exists before we manage OrderFulfillmentNotes in that fulfillment.
protected OrderFulfillmentNoteService<OrderFulfillmentNote>	getOrderFulfillmentNoteService()
protected OrderFulfillmentService<com.broadleafcommerce.order.client.domain.OrderFulfillment>	getOrderFulfillmentService()
org.springframework.data.domain.Page<OrderFulfillmentNote>	readAllOrderFulfillmentNotes(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String orderFulfillmentId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
OrderFulfillmentNote	readOrderFulfillmentNoteById(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String orderFulfillmentId, String orderFulfillmentNoteId)

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

OrderFulfillmentNoteEndpoint

public OrderFulfillmentNoteEndpoint(OrderFulfillmentNoteService<OrderFulfillmentNote> orderFulfillmentNoteService,
                                    OrderFulfillmentService<com.broadleafcommerce.order.client.domain.OrderFulfillment> orderFulfillmentService)

Method Detail

readAllOrderFulfillmentNotes

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

readOrderFulfillmentNoteById

@Policy(permissionRoots="ORDER_FULFILLMENT_NOTE")
@FrameworkGetMapping("/{id}")
public OrderFulfillmentNote readOrderFulfillmentNoteById(@ContextOperation
                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                         @PathVariable("orderFulfillmentId")
                                                         String orderFulfillmentId,
                                                         @PathVariable("id")
                                                         String orderFulfillmentNoteId)

createOrderFulfillmentNote

@Policy(permissionRoots="ORDER_FULFILLMENT_NOTE")
@FrameworkPostMapping(consumes="application/json")
public OrderFulfillmentNote createOrderFulfillmentNote(@ContextOperation(CREATE)
                                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                       @PathVariable("orderFulfillmentId")
                                                       String orderFulfillmentId,
                                                       @RequestBody
                                                       OrderFulfillmentNote orderFulfillmentNote)

deleteOrderFulfillmentNote

@Policy(permissionRoots="ORDER_FULFILLMENT_NOTE")
@FrameworkDeleteMapping("/{id}")
public void deleteOrderFulfillmentNote(@ContextOperation(DELETE)
                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                       @PathVariable("orderFulfillmentId")
                                       String orderFulfillmentId,
                                       @PathVariable("id")
                                       String orderFulfillmentNoteId)

ensureOrderFulfillmentExists

protected void ensureOrderFulfillmentExists(@NonNull
                                            @NonNull String orderFulfillmentId,
                                            com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Ensures that the OrderFulfillment exists before we manage OrderFulfillmentNotes in that fulfillment.

Parameters:

orderFulfillmentId - ID of the fulfillment to check for existence

contextInfo - context information around sandbox and multitenant state

ensureNoteBelongsToOrderFulfillmentAndReturn

protected OrderFulfillmentNote ensureNoteBelongsToOrderFulfillmentAndReturn(@NonNull
                                                                            @NonNull String orderFulfillmentId,
                                                                            @NonNull
                                                                            @NonNull String orderFulfillmentNoteId,
                                                                            com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Ensures that the OrderFulfillmentNote is associated with the specified order fulfillment ID. Also retrieves the order fulfillment note.

Parameters:

orderFulfillmentId - ID of the order fulfillment to check for association

orderFulfillmentNoteId - ID of the order fulfillment note to check for association

contextInfo - context information around sandbox and multitenant state

Returns:

the found order fulfillment note

Throws:

com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - if the order fulfillment note is not associated to the fulfillment

getOrderFulfillmentNoteService

protected OrderFulfillmentNoteService<OrderFulfillmentNote> getOrderFulfillmentNoteService()

getOrderFulfillmentService

protected OrderFulfillmentService<com.broadleafcommerce.order.client.domain.OrderFulfillment> getOrderFulfillmentService()