Package com.broadleafcommerce.cartoperation.exception

Class CheckoutWorkflowActivityException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.broadleafcommerce.cartoperation.exception.CheckoutWorkflowActivityException

All Implemented Interfaces:

Serializable

public class CheckoutWorkflowActivityException
extends RuntimeException

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

Author:

Chris Kittrell (ckittrell)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CheckoutWorkflowActivityException(String failureType, String failureMessage, CheckoutProcessDto checkoutProcessDto)
CheckoutWorkflowActivityException(String failureType, String failureMessage, CheckoutProcessDto checkoutProcessDto, List<PaymentTransactionFailureDetail> paymentTransactionFailureDetails)
CheckoutWorkflowActivityException(String failureType, String failureMessage, Throwable cause, CheckoutProcessDto checkoutProcessDto)
CheckoutWorkflowActivityException(String failureType, String failureMessage, Map<String,String> itemFailureMessages, CheckoutProcessDto checkoutProcessDto)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalInfo()	The map that can be used to specify the additional info for this exception.
com.broadleafcommerce.cart.client.domain.Cart	getCart()	Convenient method to get the Cart from checkoutProcessDto.
CheckoutProcessDto	getCheckoutProcessDto()	The CheckoutProcessDto being processed in the activity.
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

CheckoutWorkflowActivityException

public CheckoutWorkflowActivityException(String failureType,
                                         String failureMessage,
                                         CheckoutProcessDto checkoutProcessDto)

CheckoutWorkflowActivityException

public CheckoutWorkflowActivityException(String failureType,
                                         String failureMessage,
                                         Throwable cause,
                                         CheckoutProcessDto checkoutProcessDto)

CheckoutWorkflowActivityException

public CheckoutWorkflowActivityException(String failureType,
                                         String failureMessage,
                                         Map<String,String> itemFailureMessages,
                                         CheckoutProcessDto checkoutProcessDto)

CheckoutWorkflowActivityException

public CheckoutWorkflowActivityException(String failureType,
                                         String failureMessage,
                                         CheckoutProcessDto checkoutProcessDto,
                                         List<PaymentTransactionFailureDetail> paymentTransactionFailureDetails)

Method Detail

getCart

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

Convenient method to get the Cart from checkoutProcessDto.

Returns:

the Cart from checkoutProcessDto

getCheckoutProcessDto

public CheckoutProcessDto getCheckoutProcessDto()

The CheckoutProcessDto being processed in the activity.

Returns:

The CheckoutProcessDto being processed in the activity.

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.

getAdditionalInfo

public Map<String,Object> getAdditionalInfo()

The map that can be used to specify the additional info for this exception.

Returns:

the map with additional info for this exception

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.