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

Class CodeGeneratorEndpoint

java.lang.Object

com.broadleafcommerce.promotion.campaign.web.endpoint.CodeGeneratorEndpoint

@FrameworkRestController
@FrameworkMapping("/code-generators")
@DataRouteByExample(CodeGenerator.class)
public class CodeGeneratorEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI
protected CampaignCodeService<CampaignCode>	codeService
protected CodeGeneratorService<CodeGenerator>	service

Constructor Summary

Constructors

Constructor	Description
CodeGeneratorEndpoint(CodeGeneratorService<CodeGenerator> service, CampaignCodeService<CampaignCode> codeService)

Method Summary

Modifier and Type	Method	Description
CodeGenerator	createCodeGenerator(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, CodeGenerator req)
void	deleteCodeGenerator(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
org.springframework.data.domain.Page<CodeGenerator>	readCampaignCodeByCampaign(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String campaignId, org.springframework.data.domain.Pageable page)
CodeGenerator	readCodeGeneratorById(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String campaignId)
CodeGenerator	replaceCodeGenerator(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, CodeGenerator req)
CodeGenerator	updateCodeGenerator(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, CodeGenerator req)

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

service

protected final CodeGeneratorService<CodeGenerator> service

codeService

protected final CampaignCodeService<CampaignCode> codeService

Constructor Detail

CodeGeneratorEndpoint

public CodeGeneratorEndpoint(CodeGeneratorService<CodeGenerator> service,
                             CampaignCodeService<CampaignCode> codeService)

Method Detail

readCampaignCodeByCampaign

@FrameworkGetMapping("/by-campaign/{campaignId}")
@Policy(permissionRoots="CAMPAIGN")
public org.springframework.data.domain.Page<CodeGenerator> readCampaignCodeByCampaign(javax.servlet.http.HttpServletRequest request,
                                                                                      @ContextOperation
                                                                                      com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                      @PathVariable("campaignId")
                                                                                      String campaignId,
                                                                                      @PageableDefault(size=50)
                                                                                      org.springframework.data.domain.Pageable page)

readCodeGeneratorById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="CAMPAIGN")
public CodeGenerator readCodeGeneratorById(javax.servlet.http.HttpServletRequest request,
                                           @ContextOperation
                                           com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                           @PathVariable("id")
                                           String campaignId)

updateCodeGenerator

@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
@Policy(permissionRoots="CAMPAIGN")
public CodeGenerator updateCodeGenerator(javax.servlet.http.HttpServletRequest request,
                                         @ContextOperation(UPDATE)
                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                         @PathVariable("id")
                                         String id,
                                         @RequestBody
                                         CodeGenerator req)

replaceCodeGenerator

@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
@Policy(permissionRoots="CAMPAIGN")
public CodeGenerator replaceCodeGenerator(javax.servlet.http.HttpServletRequest request,
                                          @ContextOperation(UPDATE)
                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                          @PathVariable("id")
                                          String id,
                                          @RequestBody
                                          CodeGenerator req)

createCodeGenerator

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="CAMPAIGN")
public CodeGenerator createCodeGenerator(javax.servlet.http.HttpServletRequest request,
                                         @ContextOperation(CREATE)
                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                         @RequestBody
                                         CodeGenerator req)

deleteCodeGenerator

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="CAMPAIGN")
public void deleteCodeGenerator(javax.servlet.http.HttpServletRequest request,
                                @ContextOperation(DELETE)
                                com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                @PathVariable("id")
                                String id)