Package com.broadleafcommerce.orderoperation.service.provider

Interface FulfillmentCaptureClaimProvider

All Known Implementing Classes:
ExternalFulfillmentCaptureClaimProvider
public interface FulfillmentCaptureClaimProvider
Provider for interfacing with operations involving fulfillment capture claims. Typically utilizes WebClient to make requests to an external REST API.
Author:
Sunny Yu

  • Method Summary

    Modifier and Type
    Method
    Description
    <C extends com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim>
    List<C>
    createFulfillmentCaptureClaims(List<C> claimsToCreate, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Creates a list of FulfillmentCaptureClaims.
    com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary
    readByFulfillmentId(String fulfillmentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Retrieves a FulfillmentCaptureClaimSummary that belong to the given fulfillment.
    com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary
    readByPaymentId(String paymentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Retrieves a FulfillmentCaptureClaimSummary that belong to the given payment.
    List<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary>
    readByPaymentIds(List<String> paymentIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Retrieves a list of FulfillmentCaptureClaimSummaries that belong to the given payments

  • Method Details

    • readByPaymentId

      com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary readByPaymentId(String paymentId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves a FulfillmentCaptureClaimSummary that belong to the given payment.
      Parameters:
      paymentId - the id of the payment to retrieve the FulfillmentCaptureClaimSummary for
      contextInfo - context information around sandbox and multitenant state
      Returns:
      a FulfillmentCaptureClaimSummary that belong to the given payment

    • readByPaymentIds

      List<com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary> readByPaymentIds(List<String> paymentIds, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves a list of FulfillmentCaptureClaimSummaries that belong to the given payments

      Note that each payment has its own FulfillmentCaptureClaimSummary.

      Parameters:
      paymentIds - the ids of the payments to retrieve the FulfillmentCaptureClaimSummaries for
      contextInfo - context information around sandbox and multitenant state
      Returns:
      a list of FulfillmentCaptureClaimSummaries that belong to the given payments

    • readByFulfillmentId

      com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary readByFulfillmentId(String fulfillmentId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves a FulfillmentCaptureClaimSummary that belong to the given fulfillment.
      Parameters:
      fulfillmentId - the id of the order fulfillment to retrieve the FulfillmentCaptureClaimSummary for
      contextInfo - context information around sandbox and multitenant state
      Returns:
      a FulfillmentCaptureClaimSummary that belong to the given fulfillment

    • createFulfillmentCaptureClaims

      <C extends com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim> List<C> createFulfillmentCaptureClaims(List<C> claimsToCreate, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Creates a list of FulfillmentCaptureClaims.
      Parameters:
      claimsToCreate - the FulfillmentCaptureClaims to create
      contextInfo - context information around sandbox and multitenant state
      Returns:
      the created FulfillmentCaptureClaims