Package com.broadleafcommerce.cartoperation.exception

Class CheckoutWorkflowException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.broadleafcommerce.cartoperation.exception.CheckoutWorkflowException

All Implemented Interfaces:

Serializable

public class CheckoutWorkflowException
extends RuntimeException

Thrown when an issue is encountered during the execution of a CheckoutWorkflow

Author:

Chris Kittrell (ckittrell)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CheckoutWorkflowException(Exception e, com.broadleafcommerce.cart.client.domain.Cart cart)
CheckoutWorkflowException(String failureType, String failureMessage, com.broadleafcommerce.cart.client.domain.Cart cart)

Method Summary

Modifier and Type	Method	Description
com.broadleafcommerce.cart.client.domain.Cart	getCart()	The cart whose checkout is being processed in the workflow.
String	getFailureType()	The category of workflow failure that caused this exception.
Map<String,String>	getItemFailureMessages()	Line item error messages used to describe issues with individual fields, cart items, etc.
List<PaymentTransactionFailureDetail>	getPaymentTransactionFailureDetails()	A collection of PaymentTransactionFailureDetails describing how the transaction(s) failed.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckoutWorkflowException

public CheckoutWorkflowException(Exception e,
                                 com.broadleafcommerce.cart.client.domain.Cart cart)

CheckoutWorkflowException

public CheckoutWorkflowException(String failureType,
                                 String failureMessage,
                                 com.broadleafcommerce.cart.client.domain.Cart cart)

Method Detail

getCart

public com.broadleafcommerce.cart.client.domain.Cart getCart()

The cart whose checkout is being processed in the workflow.

Returns:

The cart whose checkout is being processed in the workflow.

getFailureType

public String getFailureType()

The category of workflow failure that caused this exception.

Returns:

The category of workflow failure that caused this exception.

See Also:

CheckoutFailureType

getItemFailureMessages

public Map<String,String> getItemFailureMessages()

Line item error messages used to describe issues with individual fields, cart items, etc. For example, this may consist of map entries where the key is a cart item id (or name) & the value is an explanation of why the item is misconfigured.

Returns:

Line item error messages used to describe issues with individual fields, cart items, etc.

getPaymentTransactionFailureDetails

public List<PaymentTransactionFailureDetail> getPaymentTransactionFailureDetails()

A collection of PaymentTransactionFailureDetails describing how the transaction(s) failed.

Returns:

A collection of PaymentTransactionFailureDetails describing how the transaction(s) failed.