Package com.broadleafcommerce.orderoperation.web.endpoint

Class OrderHistoryEndpoint

java.lang.Object

com.broadleafcommerce.orderoperation.web.endpoint.OrderHistoryEndpoint

@FrameworkRestController
@FrameworkMapping("/order-history")
public class OrderHistoryEndpoint
extends Object

Endpoint for viewing Order history for a customer.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
OrderHistoryEndpoint(OrderHistoryService<com.broadleafcommerce.order.client.domain.Order,OrderWithFulfillmentsAndReturns> orderHistoryService)

Method Summary

Modifier and Type	Method	Description
protected OrderHistoryService<com.broadleafcommerce.order.client.domain.Order,OrderWithFulfillmentsAndReturns>	getOrderHistoryService()
OrderWithFulfillmentsAndReturns	readOrderByIdOrNumber(String orderRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
OrderWithFulfillmentsAndReturns	readOrderByIdOrNumberForAccount(String orderRef, boolean includeChildren, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<OrderWithFulfillmentsAndReturns>	readOrderHistoryForAccount(boolean includeChildren, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<OrderWithFulfillmentsAndReturns>	readOrderHistoryForCustomer(Integer days, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

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

OrderHistoryEndpoint

public OrderHistoryEndpoint(OrderHistoryService<com.broadleafcommerce.order.client.domain.Order,OrderWithFulfillmentsAndReturns> orderHistoryService)

Method Details

readOrderHistoryForCustomer

@Policy(permissionRoots="CUSTOMER_ORDER",
        identityTypes=OWNER)
@FrameworkGetMapping
public org.springframework.data.domain.Page<OrderWithFulfillmentsAndReturns> readOrderHistoryForCustomer(@RequestParam(required=false)
 Integer days,
 @PageableDefault(sort="submitDate",direction=DESC)
 org.springframework.data.domain.Pageable page,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readOrderByIdOrNumber

@Policy(permissionRoots="CUSTOMER_ORDER",
        identityTypes=OWNER)
@FrameworkGetMapping("/{orderRef}")
public OrderWithFulfillmentsAndReturns readOrderByIdOrNumber(@PathVariable("orderRef")
 String orderRef,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readOrderHistoryForAccount

@Policy(permissionRoots="ACCOUNT_ORDER")
@FrameworkGetMapping("/account")
public org.springframework.data.domain.Page<OrderWithFulfillmentsAndReturns> readOrderHistoryForAccount(@RequestParam(required=false)
 boolean includeChildren,
 @PageableDefault(sort="submitDate",direction=DESC)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readOrderByIdOrNumberForAccount

@Policy(permissionRoots="ACCOUNT_ORDER")
@FrameworkGetMapping("/account/{orderRef}")
public OrderWithFulfillmentsAndReturns readOrderByIdOrNumberForAccount(@PathVariable("orderRef")
 String orderRef,
 @RequestParam(required=false)
 boolean includeChildren,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getOrderHistoryService

protected OrderHistoryService<com.broadleafcommerce.order.client.domain.Order,OrderWithFulfillmentsAndReturns> getOrderHistoryService()