Package com.broadleafcommerce.pricing.web.endpoint

Class FeeEndpoint

java.lang.Object

com.broadleafcommerce.pricing.web.endpoint.FeeEndpoint

@FrameworkRestController
@DataRouteByExample(Fee.class)
public class FeeEndpoint
extends Object

Author:

Julia Lopez-Pozas (jlopezpozas)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
FeeEndpoint(FeeService<Fee> feeService, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Summary

Modifier and Type	Method	Description
Fee	createFee(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Fee fee)
void	deleteFee(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
protected String	getApplicationIdFromContext(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected FeeService<Fee>	getFeeService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
org.springframework.data.domain.Page<Fee>	readAll(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)
List<Fee>	readAllByApplicationId(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
Fee	readFee(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllFeeTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
Fee	replaceFee(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Fee fee)
Fee	updateFee(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Fee fee)

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

Constructor Details

FeeEndpoint

public FeeEndpoint(FeeService<Fee> feeService,
 com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Details

readAll

@FrameworkGetMapping("/fees")
@Policy(permissionRoots="FEE")
public org.springframework.data.domain.Page<Fee> readAll(jakarta.servlet.http.HttpServletRequest request,
 @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)

readAllByApplicationId

@FrameworkGetMapping("/fees-by-application")
@Policy(permissionRoots="FEE")
public List<Fee> readAllByApplicationId(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

readFee

@FrameworkGetMapping("/fees/{id}")
@Policy(permissionRoots="FEE")
public Fee readFee(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id)

updateFee

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

replaceFee

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

createFee

@FrameworkPostMapping(consumes="application/json",
                      value="/fees")
@Policy(permissionRoots="FEE")
public Fee createFee(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 Fee fee)

deleteFee

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

replaceAllFeeTranslations

@FrameworkPutMapping(value="/fees/{id}/translations/{locale}",
                     consumes="application/json")
@Policy(permissionRoots="FEE")
public com.broadleafcommerce.translation.service.dto.TranslationsPayload replaceAllFeeTranslations(@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)

getApplicationIdFromContext

protected String getApplicationIdFromContext(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getFeeService

@NonNull
protected FeeService<Fee> getFeeService()

getTranslationEntityService

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