Package com.broadleafcommerce.order.web.endpoint

Class FulfillmentCaptureClaimEndpoint

java.lang.Object
com.broadleafcommerce.order.web.endpoint.FulfillmentCaptureClaimEndpoint
@FrameworkRestController @FrameworkMapping("/fulfillment-capture-claims") @DataRouteByExample(com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim.class) public class FulfillmentCaptureClaimEndpoint extends Object
Endpoint for management of FulfillmentCaptureClaim.

  • Field Details

  • Constructor Details

    • FulfillmentCaptureClaimEndpoint

      public FulfillmentCaptureClaimEndpoint(FulfillmentCaptureClaimService<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim> fulfillmentCaptureClaimService, FulfillmentCaptureClaimSummaryService<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary> fulfillmentCaptureClaimSummaryService)

  • Method Details

    • readAllFulfillmentCaptureClaims

      @Policy(permissionRoots="ORDER") @FrameworkGetMapping public org.springframework.data.domain.Page<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim> readAllFulfillmentCaptureClaims(@ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, cz.jirutka.rsql.parser.ast.Node filters, @PageableDefault(size=50) org.springframework.data.domain.Pageable page)

    • readByPaymentId

      @Deprecated(since="Order Service 2.1.0, Release Train 2.2.0", forRemoval=true) @Policy(permissionRoots="ORDER") @FrameworkGetMapping(params="paymentId") public com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary readByPaymentId(@RequestParam("paymentId") String paymentId, @ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use readSummaryByPaymentId(java.lang.String, com.broadleafcommerce.data.tracking.core.context.ContextInfo).

    • readSummaryByPaymentId

      @Policy(permissionRoots="ORDER") @FrameworkGetMapping("/summaries/by-payment-id") public com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary readSummaryByPaymentId(@RequestParam("paymentId") String paymentId, @ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Parameters:
      paymentId - id of the payment related to the fulfillment capture claim to summarize
      context - context information
      Returns:
      summary of a fulfillment capture claim
      Since:
      Order Service 2.1.0, Release Train 2.2.0

    • readByPaymentIds

      @Deprecated(since="Order Service 2.1.0, Release Train 2.2.0", forRemoval=true) @Policy(permissionRoots="ORDER") @FrameworkGetMapping(params="paymentIds") public List<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary> readByPaymentIds(@RequestParam("paymentIds") List<String> paymentIds, @ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use readSummariesByPaymentIds(java.util.List<java.lang.String>, com.broadleafcommerce.data.tracking.core.context.ContextInfo).

    • readSummariesByPaymentIds

      @Policy(permissionRoots="ORDER") @FrameworkGetMapping("/summaries/by-payment-ids") public List<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary> readSummariesByPaymentIds(@RequestParam("paymentIds") List<String> paymentIds, @ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Parameters:
      paymentIds - list of payment ids related to the fulfillment capture claims to summarize
      context - context information
      Returns:
      list of all fulfillment claim summaries
      Since:
      Order Service 2.1.0, Release Train 2.2.0

    • readByFulfillmentId

      @Deprecated(since="Order Service 2.1.0, Release Train 2.2.0", forRemoval=true) @Policy(permissionRoots="ORDER") @FrameworkGetMapping(params="fulfillmentId") public com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary readByFulfillmentId(@RequestParam("fulfillmentId") String fulfillmentId, @ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use readSummaryByFulfillmentId(java.lang.String, com.broadleafcommerce.data.tracking.core.context.ContextInfo).

    • readSummaryByFulfillmentId

      @Policy(permissionRoots="ORDER") @FrameworkGetMapping("/summaries/by-fulfillment-id") public com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary readSummaryByFulfillmentId(@RequestParam("fulfillmentId") String fulfillmentId, @ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Parameters:
      fulfillmentId - id of the fulfillment related to the fulfillment capture claim to summarize
      context - context information
      Returns:
      list of all fulfillment claim summaries
      Since:
      Order Service 2.1.0, Release Train 2.2.0

    • createFulfillmentCaptureClaim

      @Policy(permissionRoots="ORDER") @FrameworkPostMapping public com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim createFulfillmentCaptureClaim(@RequestBody com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim fulfillmentCaptureClaim, @ContextOperation(CREATE) com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

    • createFulfillmentCaptureClaims

      @Policy(permissionRoots="ORDER") @FrameworkPostMapping("/bulk-create") public List<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim> createFulfillmentCaptureClaims(@RequestBody List<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim> fulfillmentCaptureClaims, @ContextOperation(CREATE) com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

    • updateFulfillmentCaptureClaim

      @Policy(permissionRoots="ORDER") @FrameworkPatchMapping("/{id}") public com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim updateFulfillmentCaptureClaim(@PathVariable("id") String id, @RequestBody com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim req, @ContextOperation(UPDATE) com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

    • deleteFulfillmentCaptureClaim

      @Policy(permissionRoots="ORDER") @FrameworkDeleteMapping("/{id}") public void deleteFulfillmentCaptureClaim(@ContextOperation(DELETE) com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @PathVariable("id") String fulfillmentCaptureClaimId)

    • getFulfillmentCaptureClaimService

      protected FulfillmentCaptureClaimService<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim> getFulfillmentCaptureClaimService()

    • getFulfillmentCaptureClaimSummaryService

      protected FulfillmentCaptureClaimSummaryService<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary> getFulfillmentCaptureClaimSummaryService()