Package com.broadleafcommerce.promotion.campaign.web.endpoint

Class CampaignCodeAuditDetailEndpoint

java.lang.Object

com.broadleafcommerce.promotion.campaign.web.endpoint.CampaignCodeAuditDetailEndpoint

@FrameworkRestController
@DataRouteByExample(CampaignCodeAuditDetail.class)
@FrameworkMapping("/campaign-code-audit-details")
public class CampaignCodeAuditDetailEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI
protected CampaignCodeAuditDetailService<CampaignCodeAuditDetail>	campaignCodeAuditDetailService
protected CampaignCodeService<CampaignCode>	campaignCodeService
protected CampaignCodeUsageValidator	campaignCodeUsageValidator
protected CodeUsabilityService	codeUsabilityService

Constructor Summary

Constructors

Constructor	Description
CampaignCodeAuditDetailEndpoint(CampaignCodeService<CampaignCode> campaignCodeService, CampaignCodeAuditDetailService<CampaignCodeAuditDetail> campaignCodeAuditDetailService, CodeUsabilityService codeUsabilityService, CampaignCodeUsageValidator campaignCodeUsageValidator)

Method Summary

Modifier and Type	Method	Description
int	countUsesLeftForCampaignCode(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String campaignCodeId)
CampaignCodeAuditDetail	createCampaignCodeAuditDetail(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, CampaignCodeAuditDetail campaignCodeAuditDetail)
void	deleteCampaignCodeAuditDetail(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo	findCampaignTrackingIdByCode(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String campaignCode)
org.springframework.data.domain.Page<CampaignCodeAuditDetail>	readAllCampaignCodeAuditDetails(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
CampaignCodeAuditDetail	readCampaignCodeAuditDetailById(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
CampaignCodeAuditDetail	replaceCampaignCodeAuditDetail(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, CampaignCodeAuditDetail campaignCodeAuditDetail)
CampaignCodeAuditDetail	updateCampaignCodeAuditDetail(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, CampaignCodeAuditDetail campaignCodeAuditDetail)
com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult	validateCampaignCodeUsage(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, List<String> campaignCodes)

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

campaignCodeService

protected final CampaignCodeService<CampaignCode> campaignCodeService

campaignCodeAuditDetailService

protected final CampaignCodeAuditDetailService<CampaignCodeAuditDetail> campaignCodeAuditDetailService

codeUsabilityService

protected final CodeUsabilityService codeUsabilityService

campaignCodeUsageValidator

protected final CampaignCodeUsageValidator campaignCodeUsageValidator

Constructor Detail

CampaignCodeAuditDetailEndpoint

public CampaignCodeAuditDetailEndpoint(CampaignCodeService<CampaignCode> campaignCodeService,
                                       CampaignCodeAuditDetailService<CampaignCodeAuditDetail> campaignCodeAuditDetailService,
                                       CodeUsabilityService codeUsabilityService,
                                       CampaignCodeUsageValidator campaignCodeUsageValidator)

Method Detail

readCampaignCodeAuditDetailById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots={"CAMPAIGN_CODE_AUDIT_DETAIL","CAMPAIGN"})
public CampaignCodeAuditDetail readCampaignCodeAuditDetailById(@ContextOperation
                                                               com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                               @PathVariable("id")
                                                               String id)

readAllCampaignCodeAuditDetails

@FrameworkGetMapping
@Policy(permissionRoots={"CAMPAIGN_CODE_AUDIT_DETAIL","CAMPAIGN"})
public org.springframework.data.domain.Page<CampaignCodeAuditDetail> readAllCampaignCodeAuditDetails(@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)

countUsesLeftForCampaignCode

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

findCampaignTrackingIdByCode

@FrameworkGetMapping("/{campaignCode}/usability-info")
@Policy(permissionRoots={"CAMPAIGN_CODE_AUDIT_DETAIL","CAMPAIGN"})
public com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo findCampaignTrackingIdByCode(@ContextOperation
                                                                                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                                                          @PathVariable("campaignCode")
                                                                                                                          String campaignCode)

validateCampaignCodeUsage

@FrameworkGetMapping("/validate-uses")
@Policy(permissionRoots={"CAMPAIGN_CODE_AUDIT_DETAIL","CAMPAIGN"})
public com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult validateCampaignCodeUsage(javax.servlet.http.HttpServletRequest request,
                                                                                                                               @ContextOperation
                                                                                                                               com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                                                               @RequestParam
                                                                                                                               List<String> campaignCodes)

createCampaignCodeAuditDetail

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots={"CAMPAIGN_CODE_AUDIT_DETAIL","CAMPAIGN"})
public CampaignCodeAuditDetail createCampaignCodeAuditDetail(@ContextOperation(CREATE)
                                                             com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                             @RequestBody
                                                             CampaignCodeAuditDetail campaignCodeAuditDetail)

replaceCampaignCodeAuditDetail

@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
@Policy(permissionRoots={"CAMPAIGN_CODE_AUDIT_DETAIL","CAMPAIGN"})
public CampaignCodeAuditDetail replaceCampaignCodeAuditDetail(@ContextOperation(UPDATE)
                                                              com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                              @PathVariable("id")
                                                              String id,
                                                              @RequestBody
                                                              CampaignCodeAuditDetail campaignCodeAuditDetail)

updateCampaignCodeAuditDetail

@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
@Policy(permissionRoots={"CAMPAIGN_CODE_AUDIT_DETAIL","CAMPAIGN"})
public CampaignCodeAuditDetail updateCampaignCodeAuditDetail(@ContextOperation(UPDATE)
                                                             com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                             @PathVariable("id")
                                                             String id,
                                                             @RequestBody
                                                             CampaignCodeAuditDetail campaignCodeAuditDetail)

deleteCampaignCodeAuditDetail

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