Package com.broadleafcommerce.pricing.web.endpoint

Class PriceDataEndpoint

java.lang.Object

com.broadleafcommerce.pricing.web.endpoint.PriceDataEndpoint

@FrameworkRestController
@FrameworkMapping("/price-data")
@DataRouteByExample(PriceData.class)
public class PriceDataEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
protected final PriceDataService<PriceData>	priceDataService
protected PricingTransactionService	pricingTransactionalService

Constructor Summary

Constructors

Constructor	Description
PriceDataEndpoint(PriceDataService<PriceData> service)

Method Summary

Modifier and Type	Method	Description
PriceData	createPriceData(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, PriceData req)
void	deletePriceData(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
protected PricingTransactionService	getPricingTransactionalService()
List<PriceData>	readBulkPriceData(cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Allows bulk read of price data without requiring target/price list id/etc.
PriceData	readPriceData(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
org.springframework.data.domain.Page<PriceData>	readPriceDataByPriceListAndTargets(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String priceListId, String targetType, List<String> targetIds, org.springframework.data.domain.Pageable page)	Deprecated, for removal: This API element is subject to removal in a future version. Use readPriceDataByPriceListAndTargets(HttpServletRequest, ContextInfo, String, String, List, Pageable, Node).
org.springframework.data.domain.Page<PriceData>	readPriceDataByPriceListAndTargets(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String priceListId, String targetType, List<String> targetIds, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
com.broadleafcommerce.pricing.client.domain.usage.RecordPriceDataUsageResponse	recordUsages(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, com.broadleafcommerce.pricing.client.domain.usage.RecordPriceDataUsageRequest recordRequest)
PriceData	replacePriceData(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, PriceData req)
void	setPricingTransactionalService(PricingTransactionService pricingTransactionalService)
PriceData	updatePriceData(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, PriceData 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

priceDataService

protected final PriceDataService<PriceData> priceDataService

pricingTransactionalService

protected PricingTransactionService pricingTransactionalService

Constructor Details

PriceDataEndpoint

public PriceDataEndpoint(PriceDataService<PriceData> service)

Method Details

readPriceDataByPriceListAndTargets

@Deprecated(since="1.7.2",
            forRemoval=true)
public org.springframework.data.domain.Page<PriceData> readPriceDataByPriceListAndTargets(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam(name="priceListId",required=false)
 String priceListId,
 @RequestParam(name="targetType",required=false)
 String targetType,
 @RequestParam(name="targetId",required=false)
 List<String> targetIds,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

Deprecated, for removal: This API element is subject to removal in a future version.

Use readPriceDataByPriceListAndTargets(HttpServletRequest, ContextInfo, String, String, List, Pageable, Node). PriceData need the ability to filter for the frontend, the old endpoints did not take in filter parameters.

readPriceDataByPriceListAndTargets

@FrameworkGetMapping
@Policy(permissionRoots="PRICE_LIST")
public org.springframework.data.domain.Page<PriceData> readPriceDataByPriceListAndTargets(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam(name="priceListId",required=false)
 String priceListId,
 @RequestParam(name="targetType",required=false)
 String targetType,
 @RequestParam(name="targetId",required=false)
 List<String> targetIds,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

readPriceData

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

updatePriceData

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

replacePriceData

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

createPriceData

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

deletePriceData

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

recordUsages

@FrameworkPostMapping(value="/usages",
                      consumes="application/json")
@Policy(permissionRoots="PRICE_LIST")
public com.broadleafcommerce.pricing.client.domain.usage.RecordPriceDataUsageResponse recordUsages(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 com.broadleafcommerce.pricing.client.domain.usage.RecordPriceDataUsageRequest recordRequest)

readBulkPriceData

@FrameworkGetMapping("/bulk")
@Policy(permissionRoots="PRICE_LIST")
public List<PriceData> readBulkPriceData(cz.jirutka.rsql.parser.ast.Node filters,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Allows bulk read of price data without requiring target/price list id/etc. Used by Data Exchange to load price data for a batch in bulk.

Parameters:

filters - RSQL filters

context - The current context

Returns:

List of price data

getPricingTransactionalService

protected PricingTransactionService getPricingTransactionalService()

setPricingTransactionalService

@Autowired
public void setPricingTransactionalService(PricingTransactionService pricingTransactionalService)