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

Class OfferAuditDetailsEndpoint

java.lang.Object

com.broadleafcommerce.promotion.offer.web.endpoint.OfferAuditDetailsEndpoint

@FrameworkRestController
@FrameworkMapping("/offer-audit-details")
@DataRouteByExample(OfferAuditDetail.class)
public class OfferAuditDetailsEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
protected final OfferAuditDetailService<OfferAuditDetail>	service

Constructor Summary

Constructors

Constructor	Description
OfferAuditDetailsEndpoint(OfferAuditDetailService<OfferAuditDetail> service)

Method Summary

Modifier and Type	Method	Description
OfferAuditDetail	createOfferAuditDetail(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, OfferAuditDetail req)
void	deleteOfferAuditDetail(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
org.springframework.data.domain.Page<OfferAuditDetail>	readAllAuditDetails(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
OfferAuditDetail	readOfferAuditDetail(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String offerAuditDetailId)
List<OfferAuditDetail>	recordOfferUsages(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, List<OfferUsageDetails> usageDetails)
OfferAuditDetail	replaceOfferAuditDetail(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, OfferAuditDetail req)
OfferAuditDetail	updateOfferAuditDetail(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, OfferAuditDetail 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 OfferAuditDetailService<OfferAuditDetail> service

Constructor Details

OfferAuditDetailsEndpoint

public OfferAuditDetailsEndpoint(OfferAuditDetailService<OfferAuditDetail> service)

Method Details

readAllAuditDetails

@FrameworkGetMapping
@Policy(permissionRoots="OFFER_AUDIT_DETAIL")
public org.springframework.data.domain.Page<OfferAuditDetail> readAllAuditDetails(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

readOfferAuditDetail

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="OFFER_AUDIT_DETAIL")
public OfferAuditDetail readOfferAuditDetail(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String offerAuditDetailId)

updateOfferAuditDetail

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

replaceOfferAuditDetail

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

createOfferAuditDetail

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="OFFER_AUDIT_DETAIL")
public OfferAuditDetail createOfferAuditDetail(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 OfferAuditDetail req)

deleteOfferAuditDetail

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

recordOfferUsages

@FrameworkPostMapping(value="/record-offer-usages",
                      consumes="application/json")
@Policy(permissionRoots="OFFER_AUDIT_DETAIL")
public List<OfferAuditDetail> recordOfferUsages(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 List<OfferUsageDetails> usageDetails)