Package com.broadleafcommerce.cart.service.messaging.event

Class CheckoutRollbackEvent

java.lang.Object
com.broadleafcommerce.cart.service.messaging.event.CheckoutRollbackEvent
All Implemented Interfaces:
Serializable
public class CheckoutRollbackEvent extends Object implements Serializable
A message event dispatched when a checkout workflow encounters an unrecoverable error and must roll back the work of its checkout workflow activities.
Author:
Chris Kittrell (ckittrell)
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    CheckoutRollbackEvent()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCartId()
    The id of the cart that was submitted for checkout
    com.broadleafcommerce.data.tracking.core.context.ContextInfo
    getContextInfo()
    The ContextInfo derived from the original request containing tenant and sandbox info.
    String
    getFailureType()
    The failureType indicating the cause of rollback
    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
    setCartId(String cartId)
    The id of the cart that was submitted for checkout
    void
    setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    The ContextInfo derived from the original request containing tenant and sandbox info.
    void
    setFailureType(String failureType)
    The failureType indicating the cause of rollback
    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

    • CheckoutRollbackEvent

      public CheckoutRollbackEvent()

  • Method Details

    • getCartId

      public String getCartId()
      The id of the cart that was submitted for checkout
      Returns:
      The id of the cart that was submitted for checkout

    • 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

    • getFailureType

      @Nullable public String getFailureType()
      The failureType indicating the cause of rollback
      Returns:
      The failureType indicating the cause of rollback

    • getContextInfo

      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

    • setCartId

      public void setCartId(String cartId)
      The id of the cart that was submitted for checkout

    • 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

    • setFailureType

      public void setFailureType(@Nullable String failureType)
      The failureType indicating the cause of rollback

    • setContextInfo

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