Package com.broadleafcommerce.cartoperation.service.payment

Interface CheckoutPaymentMethodService

All Known Implementing Classes:
DefaultCheckoutPaymentMethodService
public interface CheckoutPaymentMethodService
This service provides information about the configured payment methods and gateways.
Author:
Marie Standeven (mariestandeven)

  • Method Summary

    Modifier and Type
    Method
    Description
    CheckoutPaymentExpectations
    getCheckoutPaymentExpectations(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.order.common.domain.CustomerRef customer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Get the consolidated checkout payment expectations (requirements) and available options.
    List<CheckoutPaymentMethodOption>
    getCheckoutPaymentMethodOptions(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.order.common.domain.CustomerRef customer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Find the available checkout payment method options for the given cart, customer, and context.
    boolean
    isPaymentRequired(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Check if an active payment is required to submit checkout for the cart.
    boolean
    isSavedPaymentMethodRequired(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Check if a saved payment method is required to submit checkout for the cart.

  • Method Details

    • getCheckoutPaymentMethodOptions

      List<CheckoutPaymentMethodOption> getCheckoutPaymentMethodOptions(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.order.common.domain.CustomerRef customer, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Find the available checkout payment method options for the given cart, customer, and context.
      Parameters:
      cart - the current cart in checkout
      customer - a reference to the current customer in checkout
      contextInfo - context information around sandbox and multitenant state
      Returns:
      a list of payment method options available in the current checkout context

    • getCheckoutPaymentExpectations

      CheckoutPaymentExpectations getCheckoutPaymentExpectations(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.order.common.domain.CustomerRef customer, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Get the consolidated checkout payment expectations (requirements) and available options.
      Parameters:
      cart - the current cart in checkout
      customer - a reference to the current customer in checkout
      contextInfo - context information around sandbox and multitenant state
      Returns:
      checkout payment expectations and options
      Since:
      Cart Operation Service 3.0.0, Release Train 3.0.0

    • isPaymentRequired

      boolean isPaymentRequired(com.broadleafcommerce.cart.client.domain.Cart cart, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Check if an active payment is required to submit checkout for the cart.
      Parameters:
      cart - the current cart in checkout
      contextInfo - context information around sandbox and multitenant state
      Returns:
      true if a payment is required, false otherwise
      Since:
      Cart Operation Service 3.0.0, Release Train 3.0.0

    • isSavedPaymentMethodRequired

      boolean isSavedPaymentMethodRequired(com.broadleafcommerce.cart.client.domain.Cart cart, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Check if a saved payment method is required to submit checkout for the cart.
      Parameters:
      cart - the current cart in checkout
      contextInfo - context information around sandbox and multitenant state
      Returns:
      true if a saved payment method is required, false otherwise
      Since:
      Cart Operation Service 3.0.0, Release Train 3.0.0