Package com.broadleafcommerce.cartoperation.web.endpoint

Class FulfillmentOptionEndpoint

java.lang.Object

com.broadleafcommerce.cartoperation.web.endpoint.FulfillmentOptionEndpoint

@FrameworkRestController
@FrameworkMapping("/fulfillment-options")
@DataRouteByKey("cartoperation")
public class FulfillmentOptionEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FULFILLMENT_OPTION_URI

Constructor Summary

Constructors

Constructor	Description
FulfillmentOptionEndpoint(CartResolverService cartResolverService, CartVersionValidationService cartVersionValidationService, FulfillmentOptionRequestService fulfillmentOptionRequestService, CartOperationService cartOperationService)

Method Summary

Modifier and Type	Method	Description
protected String	cartNotFoundMessage(String cartId)
CartFulfillmentResponse	determineOptionsAndGroups(com.broadleafcommerce.fulfillment.common.domain.Address address, String cartId, Integer cartVersion, com.broadleafcommerce.order.common.domain.CustomerRef customer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Convenience endpoint to get the cart with all fulfillment options, and ensure that options for the default service level are selected all at once.
protected CartOperationService	getCartOperationService()
protected CartResolverService	getCartResolverService()
protected CartVersionValidationService	getCartVersionValidationService()
protected FulfillmentOptionRequestService	getFulfillmentOptionRequestService()
com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionResponse	getOptions(String cartId, Integer cartVersion, com.broadleafcommerce.order.common.domain.CustomerRef customer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig	getPricingConfigForContext(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Map<String,javax.money.MonetaryAmount>	getServiceLevelMap(String cartId, Integer cartVersion, com.broadleafcommerce.order.common.domain.CustomerRef customer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected com.broadleafcommerce.cart.client.domain.Cart	resolveCart(String cartId, com.broadleafcommerce.order.common.domain.CustomerRef customer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected com.broadleafcommerce.cart.client.domain.Cart	resolveCartForRead(String cartId, Integer cartVersion, com.broadleafcommerce.order.common.domain.CustomerRef customer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected com.broadleafcommerce.cart.client.domain.Cart	resolveCartForUpdate(String cartId, Integer cartVersion, com.broadleafcommerce.order.common.domain.CustomerRef customer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
CartFulfillmentResponse	selectOption(com.broadleafcommerce.order.common.domain.PricedFulfillmentOption pricedFulfillmentOption, String cartId, Integer cartVersion, com.broadleafcommerce.order.common.domain.CustomerRef customer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
CartFulfillmentResponse	updateAddressOnGroup(com.broadleafcommerce.fulfillment.common.domain.Address address, String cartId, String fulfillmentGroupReference, Integer cartVersion, com.broadleafcommerce.order.common.domain.CustomerRef customer, 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

FULFILLMENT_OPTION_URI

public static final String FULFILLMENT_OPTION_URI

See Also:

• Constant Field Values

Constructor Details

FulfillmentOptionEndpoint

public FulfillmentOptionEndpoint(CartResolverService cartResolverService,
 CartVersionValidationService cartVersionValidationService,
 FulfillmentOptionRequestService fulfillmentOptionRequestService,
 CartOperationService cartOperationService)

Method Details

getOptions

@FrameworkGetMapping("/{cartId}")
public com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionResponse getOptions(@PathVariable
 String cartId,
 Integer cartVersion,
 com.broadleafcommerce.order.common.domain.CustomerRef customer,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

determineOptionsAndGroups

@FrameworkPostMapping("/{cartId}")
public CartFulfillmentResponse determineOptionsAndGroups(@RequestBody(required=false)
 com.broadleafcommerce.fulfillment.common.domain.Address address,
 @PathVariable
 String cartId,
 Integer cartVersion,
 com.broadleafcommerce.order.common.domain.CustomerRef customer,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Convenience endpoint to get the cart with all fulfillment options, and ensure that options for the default service level are selected all at once.

selectOption

@FrameworkPostMapping("/{cartId}/select")
public CartFulfillmentResponse selectOption(@RequestBody
 com.broadleafcommerce.order.common.domain.PricedFulfillmentOption pricedFulfillmentOption,
 @PathVariable
 String cartId,
 Integer cartVersion,
 com.broadleafcommerce.order.common.domain.CustomerRef customer,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getServiceLevelMap

@FrameworkGetMapping("/{cartId}/service-levels")
public Map<String,javax.money.MonetaryAmount> getServiceLevelMap(@PathVariable
 String cartId,
 Integer cartVersion,
 com.broadleafcommerce.order.common.domain.CustomerRef customer,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getPricingConfigForContext

@FrameworkGetMapping("/pricing-config")
public com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig getPricingConfigForContext(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

updateAddressOnGroup

@FrameworkPostMapping("/{cartId}/address/{fulfillmentGroupReference}")
public CartFulfillmentResponse updateAddressOnGroup(@RequestBody
 com.broadleafcommerce.fulfillment.common.domain.Address address,
 @PathVariable
 String cartId,
 @PathVariable
 String fulfillmentGroupReference,
 Integer cartVersion,
 com.broadleafcommerce.order.common.domain.CustomerRef customer,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

resolveCartForRead

protected com.broadleafcommerce.cart.client.domain.Cart resolveCartForRead(String cartId,
 @Nullable
 Integer cartVersion,
 @Nullable
 com.broadleafcommerce.order.common.domain.CustomerRef customer,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

resolveCartForUpdate

protected com.broadleafcommerce.cart.client.domain.Cart resolveCartForUpdate(String cartId,
 @Nullable
 Integer cartVersion,
 @Nullable
 com.broadleafcommerce.order.common.domain.CustomerRef customer,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

resolveCart

protected com.broadleafcommerce.cart.client.domain.Cart resolveCart(@NonNull
 String cartId,
 @Nullable
 com.broadleafcommerce.order.common.domain.CustomerRef customer,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

cartNotFoundMessage

protected String cartNotFoundMessage(String cartId)

getCartResolverService

protected CartResolverService getCartResolverService()

getCartVersionValidationService

protected CartVersionValidationService getCartVersionValidationService()

getFulfillmentOptionRequestService

protected FulfillmentOptionRequestService getFulfillmentOptionRequestService()

getCartOperationService

protected CartOperationService getCartOperationService()