Package com.broadleafcommerce.promotion.campaign.web.endpoint

Class CampaignCodeExportEndpoint

  • @FrameworkRestController
@DataRouteByExample(Campaign.class)
public class CampaignCodeExportEndpoint
extends Object

    • Constructor Summary

      Constructors 
      Constructor Description
      CampaignCodeExportEndpoint​(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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody> downloadCampaignCodeExport​(String exportId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, javax.servlet.http.HttpServletResponse response)  
      com.broadleafcommerce.common.dataexport.domain.Export exportCampaignCode​(String filterString, com.broadleafcommerce.common.dataexport.domain.ExportRequest exportRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)  
      protected com.broadleafcommerce.common.dataexport.service.ExportDownloadService getExportDownloadService()  
      protected com.broadleafcommerce.common.dataexport.service.ExportManager getExportManager()  
      protected com.broadleafcommerce.common.dataexport.service.ExportService<com.broadleafcommerce.common.dataexport.domain.Export> getExportService()  
      org.springframework.http.ResponseEntity<Object> readCampaignExportsForAuthor​(String campaignId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)  
      org.springframework.http.ResponseEntity<?> readExportById​(String exportId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)  

    • Constructor Detail

      • CampaignCodeExportEndpoint

        public CampaignCodeExportEndpoint​(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 Detail

      • readExportById

        @FrameworkGetMapping("/exports/campaign-codes/{id}")
@Policy(permissionRoots="CAMPAIGN")
public org.springframework.http.ResponseEntity<?> readExportById​(@PathVariable("id")
                                                                 String exportId,
                                                                 @ContextOperation(READ)
                                                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

      • exportCampaignCode

        @FrameworkPostMapping(value="/exports/campaign-codes",
                      consumes="application/json")
@Policy(permissionRoots="CAMPAIGN")
public com.broadleafcommerce.common.dataexport.domain.Export exportCampaignCode​(@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)

      • downloadCampaignCodeExport

        @FrameworkGetMapping("/exports/campaign-codes/{id}/download")
@Policy(permissionRoots="CAMPAIGN")
public org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody> downloadCampaignCodeExport​(@PathVariable("id")
                                                                                                                                                       String exportId,
                                                                                                                                                       @ContextOperation(READ)
                                                                                                                                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                                                                                                                                       javax.servlet.http.HttpServletResponse response)

      • readCampaignExportsForAuthor

        @FrameworkGetMapping("/my-exports/campaign-codes")
@Policy(permissionRoots="CAMPAIGN")
public org.springframework.http.ResponseEntity<Object> readCampaignExportsForAuthor​(@RequestParam("campaignId")
                                                                                    String campaignId,
                                                                                    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()