Package com.broadleafcommerce.promotion.offer.web.endpoint

Class OfferEngineEndpoint

java.lang.Object

com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

@FrameworkRestController
@FrameworkMapping("/offer-engine")
@DataRouteByExample(Offer.class)
public class OfferEngineEndpoint
extends Object

Author:

Chad Harchar (charchar)

Field Summary

Fields

Modifier and Type	Field	Description
protected OfferAuditDetailService<? extends OfferAuditDetail>	auditService
static String	BASE_URI
protected OfferCandidateService<? extends Offer>	offerCandidateService
protected OfferCodeUsageValidator	offerCodeUsageValidator
protected OfferEngineService	offerEngineService
protected OfferService<? extends Offer>	offerService
protected OfferUsageValidator	offerUsageValidator
protected OfferUserService	offerUserService
protected com.broadleafcommerce.common.extension.TypeFactory	typeFactory
protected VoucherOfferUsageValidator	voucherOfferUsageValidator

Constructor Summary

Constructors

Constructor

Description

OfferEngineEndpoint(OfferAuditDetailService<? extends OfferAuditDetail> auditService, OfferService<? extends Offer> offerService, OfferUserService offerUserService, OfferEngineService offerEngineService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, OfferCandidateService<? extends Offer> offerCandidateService, OfferUsageValidator offerUsageValidator, OfferCodeUsageValidator offerCodeUsageValidator, VoucherOfferUsageValidator voucherOfferUsageValidator)

Method Summary

Modifier and Type	Method	Description
com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse	applyOffers(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, EnhancedOrder order)
org.springframework.http.ResponseEntity<com.broadleafcommerce.common.error.ApiError>	handleBadOrderException(Exception ex, org.springframework.web.context.request.WebRequest request)
protected void	logDebug(Exception ex, org.springframework.web.context.request.WebRequest request)
com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo	retrieveCodeUsability(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String code)
com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult	validateOfferUsage(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext, List<String> offerCodes, List<String> offerIds)
com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult	validateVouchers(javax.servlet.http.HttpServletRequest request, EnhancedOrder order, boolean postCheckout, 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

auditService

protected final OfferAuditDetailService<? extends OfferAuditDetail> auditService

offerService

protected final OfferService<? extends Offer> offerService

offerUserService

protected final OfferUserService offerUserService

offerEngineService

protected final OfferEngineService offerEngineService

typeFactory

protected final com.broadleafcommerce.common.extension.TypeFactory typeFactory

offerCandidateService

protected final OfferCandidateService<? extends Offer> offerCandidateService

offerUsageValidator

protected final OfferUsageValidator offerUsageValidator

offerCodeUsageValidator

protected final OfferCodeUsageValidator offerCodeUsageValidator

voucherOfferUsageValidator

protected final VoucherOfferUsageValidator voucherOfferUsageValidator

Constructor Detail

OfferEngineEndpoint

public OfferEngineEndpoint(OfferAuditDetailService<? extends OfferAuditDetail> auditService,
                           OfferService<? extends Offer> offerService,
                           OfferUserService offerUserService,
                           OfferEngineService offerEngineService,
                           com.broadleafcommerce.common.extension.TypeFactory typeFactory,
                           OfferCandidateService<? extends Offer> offerCandidateService,
                           OfferUsageValidator offerUsageValidator,
                           OfferCodeUsageValidator offerCodeUsageValidator,
                           VoucherOfferUsageValidator voucherOfferUsageValidator)

Method Detail

retrieveCodeUsability

@FrameworkGetMapping("/code-use/{code}")
public com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo retrieveCodeUsability(javax.servlet.http.HttpServletRequest request,
                                                                                                        @ContextOperation(READ)
                                                                                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                                        @PathVariable("code")
                                                                                                        String code)

validateOfferUsage

@FrameworkGetMapping("/validate-uses")
public com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult validateOfferUsage(javax.servlet.http.HttpServletRequest request,
                                                                                                                          @ContextOperation(READ)
                                                                                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                                                          com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext,
                                                                                                                          @RequestParam
                                                                                                                          List<String> offerCodes,
                                                                                                                          @RequestParam
                                                                                                                          List<String> offerIds)

applyOffers

@FrameworkPostMapping("/apply")
public com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse applyOffers(javax.servlet.http.HttpServletRequest request,
                                                                                                    @ContextOperation(READ)
                                                                                                    com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                                    @RequestBody
                                                                                                    EnhancedOrder order)

validateVouchers

@FrameworkPostMapping("/validate-vouchers")
public com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult validateVouchers(javax.servlet.http.HttpServletRequest request,
                                                                                                                        @RequestBody
                                                                                                                        EnhancedOrder order,
                                                                                                                        @RequestParam(required=false,defaultValue="true")
                                                                                                                        boolean postCheckout,
                                                                                                                        @ContextOperation(READ)
                                                                                                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

handleBadOrderException

@ExceptionHandler(BadOrderDataException.class)
public org.springframework.http.ResponseEntity<com.broadleafcommerce.common.error.ApiError> handleBadOrderException(Exception ex,
                                                                                                                    org.springframework.web.context.request.WebRequest request)

logDebug

protected void logDebug(Exception ex,
                        org.springframework.web.context.request.WebRequest request)