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

Class SharedCodeAuditSummaryEndpoint

java.lang.Object

com.broadleafcommerce.promotion.offer.web.endpoint.SharedCodeAuditSummaryEndpoint

@FrameworkRestController
@DataRouteByExample(OfferAuditDetail.class)
@FrameworkMapping("/shared-code-audit-summaries")
public class SharedCodeAuditSummaryEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
protected final CampaignService<Campaign>	campaignService
protected final OfferAndOfferCodeUsabilityService	offerAndOfferCodeUsabilityService
protected final OfferAndOfferCodeUsageValidator	offerandOfferCodeUsageValidator
protected final OfferCodeService<OfferCode>	offerCodeService
protected final OfferService<Offer>	offerService
protected final SharedCodeSummaryService<SharedCodeAuditSummary>	sharedCodeSummaryService

Constructor Summary

Constructors

Constructor

Description

SharedCodeAuditSummaryEndpoint(OfferCodeService<OfferCode> offerCodeService, OfferService<Offer> offerService, CampaignService<Campaign> campaignService, SharedCodeSummaryService<SharedCodeAuditSummary> sharedCodeSummaryService, OfferAndOfferCodeUsabilityService offerAndOfferCodeUsabilityService, OfferAndOfferCodeUsageValidator offerandOfferCodeUsageValidator, AuditVerficationProperties auditVerificationProperties)

Method Summary

Modifier and Type	Method	Description
int	countUsesLeftForSharedCode(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String offerCodeId)
void	deleteSharedCodeAuditSummary(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo	findCodeUsabilityByCode(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String code)
protected AuditVerficationProperties	getAuditVerificationProperties()
protected boolean	isParentEntityActive(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, OfferCode offerCode)
org.springframework.data.domain.Page<SharedCodeAuditSummary>	readAllSharedCodeAuditSummaries(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
org.springframework.data.domain.Page<SharedCodeAuditSummary>	readAllSharedCodeAuditSummariesByCampaignId(String campaignId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
SharedCodeAuditSummary	readSharedCodeAuditSummaryById(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
void	updateAuditVerificationProperties(String flow, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult	validateSharedCodeUsage(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, List<String> codes)

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

offerCodeService

protected final OfferCodeService<OfferCode> offerCodeService

offerService

protected final OfferService<Offer> offerService

campaignService

protected final CampaignService<Campaign> campaignService

sharedCodeSummaryService

protected final SharedCodeSummaryService<SharedCodeAuditSummary> sharedCodeSummaryService

offerAndOfferCodeUsabilityService

protected final OfferAndOfferCodeUsabilityService offerAndOfferCodeUsabilityService

offerandOfferCodeUsageValidator

protected final OfferAndOfferCodeUsageValidator offerandOfferCodeUsageValidator

Constructor Details

SharedCodeAuditSummaryEndpoint

public SharedCodeAuditSummaryEndpoint(OfferCodeService<OfferCode> offerCodeService,
 OfferService<Offer> offerService,
 CampaignService<Campaign> campaignService,
 SharedCodeSummaryService<SharedCodeAuditSummary> sharedCodeSummaryService,
 OfferAndOfferCodeUsabilityService offerAndOfferCodeUsabilityService,
 OfferAndOfferCodeUsageValidator offerandOfferCodeUsageValidator,
 AuditVerficationProperties auditVerificationProperties)

Method Details

readSharedCodeAuditSummaryById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="SHARED_CODE_AUDIT_SUMMARY")
public SharedCodeAuditSummary readSharedCodeAuditSummaryById(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id)

readAllSharedCodeAuditSummaries

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

readAllSharedCodeAuditSummariesByCampaignId

@FrameworkGetMapping(params="campaignTrackingId")
@Policy(permissionRoots="SHARED_CODE_AUDIT_SUMMARY")
public org.springframework.data.domain.Page<SharedCodeAuditSummary> readAllSharedCodeAuditSummariesByCampaignId(@RequestParam(name="campaignTrackingId")
 String campaignId,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

countUsesLeftForSharedCode

@FrameworkGetMapping("/{offerCodeId}/uses-left")
@Policy(permissionRoots="SHARED_CODE_AUDIT_SUMMARY")
public int countUsesLeftForSharedCode(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("offerCodeId")
 String offerCodeId)

findCodeUsabilityByCode

@FrameworkGetMapping("/{code}/usability-info")
@Policy(permissionRoots="SHARED_CODE_AUDIT_SUMMARY")
public com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo findCodeUsabilityByCode(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("code")
 String code)

validateSharedCodeUsage

@FrameworkGetMapping("/validate-uses")
@Policy(permissionRoots="SHARED_CODE_AUDIT_SUMMARY")
public com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult validateSharedCodeUsage(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam
 List<String> codes)

deleteSharedCodeAuditSummary

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

isParentEntityActive

protected boolean isParentEntityActive(com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 OfferCode offerCode)

updateAuditVerificationProperties

public void updateAuditVerificationProperties(String flow,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

getAuditVerificationProperties

protected AuditVerficationProperties getAuditVerificationProperties()