Package com.broadleafcommerce.order.web.endpoint

Class OrderFulfillmentEndpoint

java.lang.Object

com.broadleafcommerce.order.web.endpoint.OrderFulfillmentEndpoint

@FrameworkRestController
@FrameworkMapping("/order-fulfillments")
@DataRouteByExample(com.broadleafcommerce.order.client.domain.OrderFulfillment.class)
public class OrderFulfillmentEndpoint
extends Object

Endpoint for management of OrderFulfillment.

Author:

Samarth Dhruva (samarthd)

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
OrderFulfillmentEndpoint(OrderFulfillmentService<com.broadleafcommerce.order.client.domain.OrderFulfillment> orderFulfillmentService, OrderFulfillmentConsolidationService<ConsolidatedOrderFulfillment> orderFulfillmentConsolidationService)

Method Summary

Modifier and Type	Method	Description
List<com.broadleafcommerce.order.client.domain.OrderFulfillment>	bulkReplaceOrCreateFulfillments(List<com.broadleafcommerce.order.client.domain.OrderFulfillment> orderFulfillments, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
com.broadleafcommerce.order.client.domain.OrderFulfillment	createOrderFulfillment(com.broadleafcommerce.order.client.domain.OrderFulfillment orderFulfillment, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
void	deleteOrderFulfillment(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String orderFulfillmentId)
protected OrderFulfillmentConsolidationService<ConsolidatedOrderFulfillment>	getOrderFulfillmentConsolidationService()
protected OrderFulfillmentService<com.broadleafcommerce.order.client.domain.OrderFulfillment>	getOrderFulfillmentService()
org.springframework.data.domain.Page<com.broadleafcommerce.order.client.domain.OrderFulfillment>	readAllOrderFulfillments(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
List<String>	readAllOrderFulfillmentsIdsIgnoreNarrowing(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, cz.jirutka.rsql.parser.ast.Node filters, int page)
List<ConsolidatedOrderFulfillment>	readAllOrderFulfillmentsIgnoreNarrowing(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, cz.jirutka.rsql.parser.ast.Node filters)
com.broadleafcommerce.order.client.domain.OrderFulfillment	readOrderFulfillmentById(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String orderFulfillmentId)
com.broadleafcommerce.order.client.domain.OrderFulfillment	replaceOrderFulfillment(String id, com.broadleafcommerce.order.client.domain.OrderFulfillment req, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

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

OrderFulfillmentEndpoint

public OrderFulfillmentEndpoint(OrderFulfillmentService<com.broadleafcommerce.order.client.domain.OrderFulfillment> orderFulfillmentService,
                                OrderFulfillmentConsolidationService<ConsolidatedOrderFulfillment> orderFulfillmentConsolidationService)

Method Detail

readAllOrderFulfillments

@Policy(permissionRoots="ORDER_FULFILLMENT")
@FrameworkGetMapping
public org.springframework.data.domain.Page<com.broadleafcommerce.order.client.domain.OrderFulfillment> readAllOrderFulfillments(@ContextOperation
                                                                                                                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                                                                                                                                 cz.jirutka.rsql.parser.ast.Node filters,
                                                                                                                                 @PageableDefault(size=50)
                                                                                                                                 org.springframework.data.domain.Pageable page)

readOrderFulfillmentById

@Policy(permissionRoots="ORDER_FULFILLMENT")
@FrameworkGetMapping("/{id}")
public com.broadleafcommerce.order.client.domain.OrderFulfillment readOrderFulfillmentById(@ContextOperation
                                                                                           com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                           @PathVariable("id")
                                                                                           String orderFulfillmentId)

createOrderFulfillment

@Policy(permissionRoots="ORDER_FULFILLMENT")
@FrameworkPostMapping
public com.broadleafcommerce.order.client.domain.OrderFulfillment createOrderFulfillment(@RequestBody
                                                                                         com.broadleafcommerce.order.client.domain.OrderFulfillment orderFulfillment,
                                                                                         @ContextOperation(CREATE)
                                                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

replaceOrderFulfillment

@Policy(permissionRoots="ORDER_FULFILLMENT")
@FrameworkPutMapping("/{id}")
public com.broadleafcommerce.order.client.domain.OrderFulfillment replaceOrderFulfillment(@PathVariable("id")
                                                                                          String id,
                                                                                          @RequestBody
                                                                                          com.broadleafcommerce.order.client.domain.OrderFulfillment req,
                                                                                          @ContextOperation(UPDATE)
                                                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

deleteOrderFulfillment

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

bulkReplaceOrCreateFulfillments

@Policy(permissionRoots="ORDER_FULFILLMENT")
@FrameworkPostMapping("/bulk-replace-create")
public List<com.broadleafcommerce.order.client.domain.OrderFulfillment> bulkReplaceOrCreateFulfillments(@RequestBody
                                                                                                        List<com.broadleafcommerce.order.client.domain.OrderFulfillment> orderFulfillments,
                                                                                                        @ContextOperation(UPDATE)
                                                                                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

readAllOrderFulfillmentsIdsIgnoreNarrowing

@Policy(permissionRoots="ORDER_FULFILLMENT_IGNORE_NARROWING")
@FrameworkGetMapping("/ignore-narrowing/ids")
public List<String> readAllOrderFulfillmentsIdsIgnoreNarrowing(@ContextOperation
                                                               com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                               cz.jirutka.rsql.parser.ast.Node filters,
                                                               @RequestParam("size")
                                                               int page)

readAllOrderFulfillmentsIgnoreNarrowing

@FrameworkGetMapping("/ignore-narrowing")
@Policy(permissionRoots="ORDER_FULFILLMENT_IGNORE_NARROWING")
public List<ConsolidatedOrderFulfillment> readAllOrderFulfillmentsIgnoreNarrowing(@ContextOperation
                                                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                  cz.jirutka.rsql.parser.ast.Node filters)

getOrderFulfillmentService

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

getOrderFulfillmentConsolidationService

protected OrderFulfillmentConsolidationService<ConsolidatedOrderFulfillment> getOrderFulfillmentConsolidationService()