Package com.broadleafcommerce.cartoperation.service.messaging.rollback

Class CheckoutRollbackEvent

java.lang.Object
com.broadleafcommerce.cartoperation.service.messaging.rollback.CheckoutRollbackEvent
All Implemented Interfaces:
Serializable
public class CheckoutRollbackEvent extends Object implements Serializable
A message event dispatched when a CheckoutWorkflow encounters an unrecoverable error & must roll back the work of its CheckoutWorkflowActivities. This event should primarily be consumed in this service as a means of triggering each activity's CheckoutWorkflowActivity#rollback(Cart, String) method.
Author:
Chris Kittrell (ckittrell)
See Also:

  • 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()
      Failure type from the CheckoutWorkflowActivityException.getFailureType()
      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)
      Failure type from the CheckoutWorkflowActivityException.getFailureType()

    • setContextInfo

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