Package com.broadleafcommerce.order.web.endpoint

Class OrderEndpoint

java.lang.Object

com.broadleafcommerce.order.web.endpoint.OrderEndpoint

@FrameworkRestController
@FrameworkMapping("/orders")
@DataRouteByExample(com.broadleafcommerce.order.client.domain.Order.class)
public class OrderEndpoint
extends Object

Endpoint for management of Orders.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	CUSTOMER_ID_FILTER

Constructor Summary

Constructors

Constructor

Description

OrderEndpoint(OrderService<com.broadleafcommerce.order.client.domain.Order> orderService, OrderConsolidationService<ConsolidatedOrder> orderConsolidationService, OrderFulfillmentItemService<com.broadleafcommerce.order.client.domain.OrderFulfillmentItem> orderFulfillmentItemService, com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> orderServiceRsqlParser)

Method Summary

Modifier and Type	Method	Description
com.broadleafcommerce.order.client.domain.Order	createOrder(com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
void	deleteOrder(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String orderId)
protected OrderConsolidationService<ConsolidatedOrder>	getOrderConsolidationService()
protected OrderFulfillmentItemService<com.broadleafcommerce.order.client.domain.OrderFulfillmentItem>	getOrderFulfillmentItemService()
protected OrderHydrationService	getOrderHydrationService()
protected OrderService<com.broadleafcommerce.order.client.domain.Order>	getOrderService()
protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node>	getOrderServiceRsqlParser()
List<com.broadleafcommerce.order.client.domain.OrderFulfillmentItem>	getReturnableItems(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String orderId)
List<String>	readAllOrderIdsIgnoreNarrowing(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, cz.jirutka.rsql.parser.ast.Node filters, int page)
org.springframework.data.domain.Page<com.broadleafcommerce.order.client.domain.Order>	readAllOrders(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
org.springframework.data.domain.Page<com.broadleafcommerce.order.client.domain.Order>	readAllOrders(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String query, org.springframework.data.domain.Pageable page, boolean hydrateChildEntities, cz.jirutka.rsql.parser.ast.Node filters)
org.springframework.data.domain.Page<com.broadleafcommerce.order.client.domain.Order>	readAllOrdersByCustomerId(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String customerId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
List<ConsolidatedOrder>	readAllOrdersIgnoreNarrowingHydrated(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, cz.jirutka.rsql.parser.ast.Node filters)
ConsolidatedOrder	readConsolidatedOrderById(String orderId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
org.springframework.data.domain.Page<CustomerOrderInfo>	readCustomerOrderInfo(ReadCustomerOrdersRequest request, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.order.client.domain.Order	readOrderByCartId(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String cartId)
com.broadleafcommerce.order.client.domain.Order	readOrderById(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String orderId)
com.broadleafcommerce.order.client.domain.Order	readOrderByOrderNumber(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String orderNumber)
void	setOrderHydrationService(OrderHydrationService orderHydrationService)
com.broadleafcommerce.order.client.domain.Order	updateOrder(String id, com.broadleafcommerce.order.client.domain.Order req, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of updateOrder(String, UpdateOrderRequest, ContextInfo)
com.broadleafcommerce.order.client.domain.Order	updateOrder(String id, UpdateOrderRequest 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 Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

CUSTOMER_ID_FILTER

public static final String CUSTOMER_ID_FILTER

See Also:

• Constant Field Values

Constructor Details

OrderEndpoint

@Autowired
public OrderEndpoint(OrderService<com.broadleafcommerce.order.client.domain.Order> orderService,
 OrderConsolidationService<ConsolidatedOrder> orderConsolidationService,
 OrderFulfillmentItemService<com.broadleafcommerce.order.client.domain.OrderFulfillmentItem> orderFulfillmentItemService,
 com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> orderServiceRsqlParser)

Method Details

readAllOrders

@FrameworkGetMapping("/search")
@Policy(permissionRoots="ORDER")
public org.springframework.data.domain.Page<com.broadleafcommerce.order.client.domain.Order> readAllOrders(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam(value="query",required=false)
 String query,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @RequestParam(required=false)
 boolean hydrateChildEntities,
 cz.jirutka.rsql.parser.ast.Node filters)

readAllOrders

@Policy(permissionRoots="ORDER")
@FrameworkGetMapping
public org.springframework.data.domain.Page<com.broadleafcommerce.order.client.domain.Order> readAllOrders(@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)

readAllOrdersByCustomerId

@Policy(permissionRoots="ORDER")
@FrameworkGetMapping("/customer/{customerId}")
public org.springframework.data.domain.Page<com.broadleafcommerce.order.client.domain.Order> readAllOrdersByCustomerId(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("customerId")
 String customerId,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

readCustomerOrderInfo

@Policy(permissionRoots="ORDER")
@FrameworkPostMapping("/customer-order-info")
public org.springframework.data.domain.Page<CustomerOrderInfo> readCustomerOrderInfo(@RequestBody
 ReadCustomerOrdersRequest request,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readOrderById

@Policy(permissionRoots="ORDER")
@FrameworkGetMapping("/{id}")
public com.broadleafcommerce.order.client.domain.Order readOrderById(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String orderId)

readOrderByCartId

@Policy(permissionRoots="ORDER")
@FrameworkGetMapping("/cart/{cartId}")
public com.broadleafcommerce.order.client.domain.Order readOrderByCartId(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("cartId")
 String cartId)

readOrderByOrderNumber

@Policy(permissionRoots="ORDER")
@FrameworkGetMapping("/order-number/{orderNumber}")
public com.broadleafcommerce.order.client.domain.Order readOrderByOrderNumber(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("orderNumber")
 String orderNumber)

createOrder

@Policy(permissionRoots="ORDER")
@FrameworkPostMapping
public com.broadleafcommerce.order.client.domain.Order createOrder(@RequestBody
 com.broadleafcommerce.order.client.domain.Order order,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

updateOrder

@Policy(permissionRoots="ORDER")
@FrameworkPatchMapping("/{id}")
@Deprecated(forRemoval=true)
public com.broadleafcommerce.order.client.domain.Order updateOrder(@PathVariable("id")
 String id,
 @RequestBody
 com.broadleafcommerce.order.client.domain.Order req,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of updateOrder(String, UpdateOrderRequest, ContextInfo)

updateOrder

@Policy(permissionRoots="ORDER")
@FrameworkPatchMapping(value="/{id}",
                       headers="Accept-Version=2")
public com.broadleafcommerce.order.client.domain.Order updateOrder(@PathVariable("id")
 String id,
 @RequestBody
 UpdateOrderRequest req,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

deleteOrder

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

getReturnableItems

@Policy(permissionRoots={"ORDER","RETURN_AUTHORIZATION"})
@FrameworkGetMapping("/{id}/returnable-items")
public List<com.broadleafcommerce.order.client.domain.OrderFulfillmentItem> getReturnableItems(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String orderId)

readAllOrderIdsIgnoreNarrowing

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

readAllOrdersIgnoreNarrowingHydrated

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

readConsolidatedOrderById

@FrameworkGetMapping("/{id}/consolidated")
@Policy(permissionRoots="ORDER",
        identityTypes=ADMIN)
public ConsolidatedOrder readConsolidatedOrderById(@PathVariable("id")
 String orderId,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

getOrderService

protected OrderService<com.broadleafcommerce.order.client.domain.Order> getOrderService()

getOrderConsolidationService

protected OrderConsolidationService<ConsolidatedOrder> getOrderConsolidationService()

getOrderFulfillmentItemService

protected OrderFulfillmentItemService<com.broadleafcommerce.order.client.domain.OrderFulfillmentItem> getOrderFulfillmentItemService()

getOrderHydrationService

protected OrderHydrationService getOrderHydrationService()

setOrderHydrationService

@Autowired
public void setOrderHydrationService(OrderHydrationService orderHydrationService)

getOrderServiceRsqlParser

protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> getOrderServiceRsqlParser()