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

Class OffersEndpoint

java.lang.Object

com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

@FrameworkRestController
@FrameworkMapping("/offers")
@DataRouteByExample(Offer.class)
public class OffersEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
OffersEndpoint(OfferService<Offer> service, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Summary

Modifier and Type	Method	Description
Offer	createOffer(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Offer req)
void	deleteOffer(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
protected OfferService<Offer>	getService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
org.springframework.data.domain.Page<Offer>	readAllOffers(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String query, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
Offer	readOfferById(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String offerId)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllOfferTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
Offer	replaceOffer(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Offer req)
Offer	updateOffer(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Offer 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

Constructor Detail

OffersEndpoint

public OffersEndpoint(OfferService<Offer> service,
                      com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Detail

readAllOffers

@FrameworkGetMapping
@Policy(permissionRoots="OFFER")
public org.springframework.data.domain.Page<Offer> readAllOffers(javax.servlet.http.HttpServletRequest request,
                                                                 @ContextOperation(READ)
                                                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                 @RequestParam(value="q",required=false)
                                                                 String query,
                                                                 @PageableDefault(size=50)
                                                                 org.springframework.data.domain.Pageable page,
                                                                 cz.jirutka.rsql.parser.ast.Node filters)

readOfferById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="OFFER")
public Offer readOfferById(javax.servlet.http.HttpServletRequest request,
                           @ContextOperation(READ)
                           com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                           @PathVariable("id")
                           String offerId)

updateOffer

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

replaceOffer

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

replaceAllOfferTranslations

@FrameworkPutMapping(value="/{id}/translations/{locale}",
                     consumes="application/json")
@Policy(permissionRoots="OFFER")
public com.broadleafcommerce.translation.service.dto.TranslationsPayload replaceAllOfferTranslations(@ContextOperation(UPDATE)
                                                                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                                     @PathVariable("id")
                                                                                                     String id,
                                                                                                     @PathVariable("locale")
                                                                                                     Locale locale,
                                                                                                     @RequestBody
                                                                                                     com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)

createOffer

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

deleteOffer

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

getService

protected OfferService<Offer> getService()

getTranslationEntityService

protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> getTranslationEntityService()