Package com.broadleafcommerce.orderoperation.service.messaging.checkout

Class CheckoutCompletionEvent

java.lang.Object
com.broadleafcommerce.orderoperation.service.messaging.checkout.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.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    CheckoutCompletionEvent()
     
    CheckoutCompletionEvent(com.broadleafcommerce.cart.client.domain.CheckoutCart cart, String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     

  • 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.
    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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CheckoutCompletionEvent

      public CheckoutCompletionEvent()

    • CheckoutCompletionEvent

      public CheckoutCompletionEvent(@Nullable com.broadleafcommerce.cart.client.domain.CheckoutCart cart, @Nullable String requestId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

  • Method Details

    • getCart

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

    • getRequestId

      @Nullable 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