Class PriceDataExportEndpoint
java.lang.Object
com.broadleafcommerce.pricing.web.endpoint.PriceDataExportEndpoint
@FrameworkRestController
@DataRouteByExample(PriceData.class)
public class PriceDataExportEndpoint
extends Object
-
Constructor Summary
ConstructorDescriptionPriceDataExportEndpoint
(com.broadleafcommerce.common.dataexport.service.ExportManager exportManager, com.broadleafcommerce.common.dataexport.service.ExportService<com.broadleafcommerce.common.dataexport.domain.Export> exportService, com.broadleafcommerce.common.dataexport.service.ExportDownloadService exportDownloadService) -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody>
downloadPriceDataExport
(String exportId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, jakarta.servlet.http.HttpServletResponse response) com.broadleafcommerce.common.dataexport.domain.Export
exportPriceData
(String exportTarget, com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) com.broadleafcommerce.common.dataexport.domain.Export
exportPriceData
(String filterString, String exportTarget, com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) Deprecated, for removal: This API element is subject to removal in a future version.protected com.broadleafcommerce.common.dataexport.service.ExportDownloadService
protected com.broadleafcommerce.common.dataexport.service.ExportManager
protected com.broadleafcommerce.common.dataexport.service.ExportService<com.broadleafcommerce.common.dataexport.domain.Export>
org.springframework.http.ResponseEntity<?>
readExportById
(String exportId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) org.springframework.http.ResponseEntity<Object>
readPriceDataExportsForAuthor
(String priceListId, String exportTarget, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
-
Constructor Details
-
PriceDataExportEndpoint
public PriceDataExportEndpoint(com.broadleafcommerce.common.dataexport.service.ExportManager exportManager, com.broadleafcommerce.common.dataexport.service.ExportService<com.broadleafcommerce.common.dataexport.domain.Export> exportService, com.broadleafcommerce.common.dataexport.service.ExportDownloadService exportDownloadService)
-
-
Method Details
-
exportPriceData
@Deprecated(since="2.0.1", forRemoval=true) @FrameworkPostMapping(value="/exports/price-data", consumes="application/json", params="cq") @Policy(permissionRoots="PRICE_LIST") public com.broadleafcommerce.common.dataexport.domain.Export exportPriceData(@RequestParam(value="cq",defaultValue="",required=false) String filterString, @RequestParam("target") String exportTarget, @RequestBody com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, @ContextOperation(READ) com.broadleafcommerce.data.tracking.core.context.ContextInfo context) Deprecated, for removal: This API element is subject to removal in a future version.since 2.0.1, in favor ofexportPriceData(String, ExportRequest, ContextInfo)
. The new implementation for export grids includes the filter string as part of theExportRequest
, instead of passing it as a parameter in the HTTP request. -
exportPriceData
@FrameworkPostMapping(value="/exports/price-data", consumes="application/json") @Policy(permissionRoots="PRICE_LIST") public com.broadleafcommerce.common.dataexport.domain.Export exportPriceData(@RequestParam("target") String exportTarget, @RequestBody com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, @ContextOperation(READ) com.broadleafcommerce.data.tracking.core.context.ContextInfo context) -
readExportById
@FrameworkGetMapping("/exports/price-data/{id}") @Policy(permissionRoots="PRICE_LIST") public org.springframework.http.ResponseEntity<?> readExportById(@PathVariable("id") String exportId, @ContextOperation(READ) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) -
downloadPriceDataExport
@FrameworkGetMapping("/exports/price-data/{id}/download") @Policy(permissionRoots="PRICE_LIST") public org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody> downloadPriceDataExport(@PathVariable("id") String exportId, @ContextOperation(READ) com.broadleafcommerce.data.tracking.core.context.ContextInfo context, jakarta.servlet.http.HttpServletResponse response) -
readPriceDataExportsForAuthor
@FrameworkGetMapping("/my-exports/price-data") @Policy(permissionRoots="PRICE_LIST") public org.springframework.http.ResponseEntity<Object> readPriceDataExportsForAuthor(@RequestParam("priceListId") String priceListId, @RequestParam("target") String exportTarget, cz.jirutka.rsql.parser.ast.Node filters, @PageableDefault(size=50) org.springframework.data.domain.Pageable pageable, @ContextOperation(READ) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) -
getExportManager
protected com.broadleafcommerce.common.dataexport.service.ExportManager getExportManager() -
getExportService
protected com.broadleafcommerce.common.dataexport.service.ExportService<com.broadleafcommerce.common.dataexport.domain.Export> getExportService() -
getExportDownloadService
protected com.broadleafcommerce.common.dataexport.service.ExportDownloadService getExportDownloadService()
-
exportPriceData(String, ExportRequest, ContextInfo)
.