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

Class CodeGeneratorEndpoint

java.lang.Object

com.broadleafcommerce.promotion.offer.web.endpoint.CodeGeneratorEndpoint

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
protected final OfferCodeService<OfferCode>	codeService
protected final CodeGeneratorService<CodeGenerator>	service

Constructor Summary

Constructors

Constructor	Description
CodeGeneratorEndpoint(CodeGeneratorService<CodeGenerator> service, OfferCodeService<OfferCode> codeService)

Method Summary

Modifier and Type	Method	Description
CodeGenerator	createCodeGenerator(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, CodeGenerator req)
void	deleteCodeGenerator(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
CodeGenerator	readCodeGeneratorById(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String campaignId)
org.springframework.data.domain.Page<CodeGenerator>	readOfferCodeByCampaign(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String campaignId, org.springframework.data.domain.Pageable page)
CodeGenerator	replaceCodeGenerator(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, CodeGenerator req)
CodeGenerator	updateCodeGenerator(jakarta.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 Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

service

protected final CodeGeneratorService<CodeGenerator> service

codeService

protected final OfferCodeService<OfferCode> codeService

Constructor Details

CodeGeneratorEndpoint

public CodeGeneratorEndpoint(CodeGeneratorService<CodeGenerator> service,
 OfferCodeService<OfferCode> codeService)

Method Details

readOfferCodeByCampaign

@FrameworkGetMapping("/by-campaign/{campaignId}")
@Policy(permissionRoots="CAMPAIGN")
public org.springframework.data.domain.Page<CodeGenerator> readOfferCodeByCampaign(jakarta.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(jakarta.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(jakarta.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(jakarta.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(jakarta.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(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id)