Class SkuInventoryExportEndpoint
java.lang.Object
com.broadleafcommerce.inventory.web.endpoint.SkuInventoryExportEndpoint
@FrameworkRestController
@DataRouteByKey("inventory")
public class SkuInventoryExportEndpoint
extends Object
- Author:
- Kelly Tisdell (ktisdell)
-
Constructor Summary
ConstructorDescriptionSkuInventoryExportEndpoint
(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>
downloadSkuInventoryExport
(String exportId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, jakarta.servlet.http.HttpServletResponse response) com.broadleafcommerce.common.dataexport.domain.Export
exportSkuInventory
(com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) com.broadleafcommerce.common.dataexport.domain.Export
exportSkuInventory
(String filterString, 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>
readSkuInventoryExportsForAuthor
(String inventoryLocationId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
-
Constructor Details
-
SkuInventoryExportEndpoint
public SkuInventoryExportEndpoint(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
-
readExportById
@FrameworkGetMapping("/exports/sku-inventory/{id}") @Policy(permissionRoots="INVENTORY") public org.springframework.http.ResponseEntity<?> readExportById(@PathVariable("id") String exportId, @ContextOperation(READ) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) -
exportSkuInventory
@Deprecated(since="2.0.1", forRemoval=true) @FrameworkPostMapping(value="/exports/sku-inventory", consumes="application/json", params="cq") @Policy(permissionRoots="INVENTORY") public com.broadleafcommerce.common.dataexport.domain.Export exportSkuInventory(@RequestParam(value="cq",defaultValue="",required=false) String filterString, @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 ofexportSkuInventory(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. -
exportSkuInventory
@FrameworkPostMapping(value="/exports/sku-inventory", consumes="application/json") @Policy(permissionRoots="INVENTORY") public com.broadleafcommerce.common.dataexport.domain.Export exportSkuInventory(@RequestBody com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, @ContextOperation(READ) com.broadleafcommerce.data.tracking.core.context.ContextInfo context) -
readSkuInventoryExportsForAuthor
@FrameworkGetMapping("/my-exports/sku-inventory") @Policy(permissionRoots="INVENTORY") public org.springframework.http.ResponseEntity<Object> readSkuInventoryExportsForAuthor(@RequestParam("inventoryLocationId") String inventoryLocationId, 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) -
downloadSkuInventoryExport
@FrameworkGetMapping("/exports/sku-inventory/{id}/download") @Policy(permissionRoots="INVENTORY") public org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody> downloadSkuInventoryExport(@PathVariable("id") String exportId, @ContextOperation(READ) com.broadleafcommerce.data.tracking.core.context.ContextInfo context, jakarta.servlet.http.HttpServletResponse response) -
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()
-
exportSkuInventory(ExportRequest, ContextInfo)
.