Package com.broadleafcommerce.cartoperation.domain

Class InventoryUnavailableException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.broadleafcommerce.cartoperation.domain.InventoryUnavailableException

All Implemented Interfaces:

Serializable

public class InventoryUnavailableException
extends RuntimeException

Exception to indicate that inventory was unavailable, typically after trying to reserve inventory.

Author:

Kelly Tisdell

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InventoryUnavailableException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace, Map<String,String> itemFailureMessages)
InventoryUnavailableException(String message, Throwable cause, Map<String,String> itemFailureMessages)
InventoryUnavailableException(String message, Map<String,String> itemFailureMessages)
InventoryUnavailableException(Throwable cause, Map<String,String> itemFailureMessages)
InventoryUnavailableException(Map<String,String> itemFailureMessages)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getItemFailureMessages()	Line item error messages to indicate which cart items were unavailable.
String	getRequestErrorType()
Map<String,Object>	getResponseBody()	Get the error response body if this was a response error.
boolean	isAvailabilityError()	Returns true if this error was caused by lack of inventory availability.
boolean	isRequestError()	Returns true if the exception was caused by a request error (e.g.
boolean	isResponseError()
void	setAvailabilityError(boolean availabilityError)	Returns true if this error was caused by lack of inventory availability.

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 Details

InventoryUnavailableException

public InventoryUnavailableException(Map<String,String> itemFailureMessages)

InventoryUnavailableException

public InventoryUnavailableException(String message,
 Map<String,String> itemFailureMessages)

InventoryUnavailableException

public InventoryUnavailableException(String message,
 Throwable cause,
 Map<String,String> itemFailureMessages)

InventoryUnavailableException

public InventoryUnavailableException(Throwable cause,
 Map<String,String> itemFailureMessages)

InventoryUnavailableException

public InventoryUnavailableException(String message,
 Throwable cause,
 boolean enableSuppression,
 boolean writableStackTrace,
 Map<String,String> itemFailureMessages)

Method Details

isRequestError

public boolean isRequestError()

Returns true if the exception was caused by a request error (e.g. timeout, connection refused, etc.)

Returns:

true if there was an error communicating with the inventory service.

isResponseError

public boolean isResponseError()

Returns:

true if the cause of this error was a web client response error.

getRequestErrorType

public String getRequestErrorType()

Returns:

An error type if the exception was caused by a request error.

getResponseBody

public Map<String,Object> getResponseBody()

Get the error response body if this was a response error.

Returns:

The API response body. If no body or this wasn't a response error, returns an empty map.

isAvailabilityError

public boolean isAvailabilityError()

Returns true if this error was caused by lack of inventory availability.

getItemFailureMessages

public Map<String,String> getItemFailureMessages()

Line item error messages to indicate which cart items were unavailable. These are typically identified by CartItem ids.

Returns:

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

setAvailabilityError

public void setAvailabilityError(boolean availabilityError)

Returns true if this error was caused by lack of inventory availability.