Package com.broadleafcommerce.cartoperation.service.messaging.completion

Class CheckoutCompletionEvent

java.lang.Object
com.broadleafcommerce.cartoperation.service.messaging.completion.CheckoutCompletionEvent
All Implemented Interfaces:
Serializable
public class CheckoutCompletionEvent extends Object implements Serializable
A message event dispatched after a cart checkout completes successfully. This event should be consumed by services that need to perform any post-checkout activities.
Author:
Jon Fleschler (jfleschler)
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    CheckoutCompletionEvent()
     
    CheckoutCompletionEvent(com.broadleafcommerce.cart.client.domain.CheckoutCart cart, List<PaymentSummary> paymentSummaries, String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo info)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.broadleafcommerce.cart.client.domain.CheckoutCart
    getCart()
    The cart object that completed the checkout workflow
    com.broadleafcommerce.data.tracking.core.context.ContextInfo
    getContextInfo()
    The ContextInfo derived from the original request containing tenant and sandbox info.
    List<PaymentSummary>
    getPaymentSummaries()
    The payments for the cart that completed the checkout workflow
    String
    getRequestId()
    The id representing this request to checkout This value can be used to identify entities that were produced due to this request and therefore need to be rolled back
    void
    setCart(com.broadleafcommerce.cart.client.domain.CheckoutCart cart)
    The cart object that completed the checkout workflow
    void
    setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    The ContextInfo derived from the original request containing tenant and sandbox info.
    void
    setPaymentSummaries(List<PaymentSummary> paymentSummaries)
    The payments for the cart that completed the checkout workflow
    void
    setRequestId(String requestId)
    The id representing this request to checkout This value can be used to identify entities that were produced due to this request and therefore need to be rolled back

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CheckoutCompletionEvent

      public CheckoutCompletionEvent(com.broadleafcommerce.cart.client.domain.CheckoutCart cart, List<PaymentSummary> paymentSummaries, String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo info)

    • CheckoutCompletionEvent

      public CheckoutCompletionEvent()

  • Method Details

    • getCart

      public com.broadleafcommerce.cart.client.domain.CheckoutCart getCart()
      The cart object that completed the checkout workflow

    • getPaymentSummaries

      public List<PaymentSummary> getPaymentSummaries()
      The payments for the cart that completed the checkout workflow

    • getRequestId

      public String getRequestId()
      The id representing this request to checkout This value can be used to identify entities that were produced due to this request and therefore need to be rolled back
      Returns:
      The id representing this request to checkout

    • getContextInfo

      @Nullable public com.broadleafcommerce.data.tracking.core.context.ContextInfo getContextInfo()
      The ContextInfo derived from the original request containing tenant and sandbox info.
      Returns:
      The ContextInfo derived from the original request

    • setCart

      public void setCart(com.broadleafcommerce.cart.client.domain.CheckoutCart cart)
      The cart object that completed the checkout workflow

    • setPaymentSummaries

      public void setPaymentSummaries(List<PaymentSummary> paymentSummaries)
      The payments for the cart that completed the checkout workflow

    • setRequestId

      public void setRequestId(String requestId)
      The id representing this request to checkout This value can be used to identify entities that were produced due to this request and therefore need to be rolled back

    • setContextInfo

      public void setContextInfo(@Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      The ContextInfo derived from the original request containing tenant and sandbox info.