Class APIException

This error indicates an exceptional outcome of some business logic. Instances of this exception in general provide additional information about the reason of this case. See the actual type referred by the type property for the description of the properties with this additional information.

Limitation: The sub classes of this APIException shown in this documentation actually do not exist. All instances are of type APIException, but with different property sets as listed in the sub classes.

The APIException is always related to a systems internal Java exception. The class provides access to some more details about this internal Java exception.

All Known Subclasses 

AspectAttributeValidationException, CreateAgentBasketLimitExceededException, CreateBasketFromOrderException, CreateCouponLineItemException, CreateOrderException, CreateTemporaryBasketLimitExceededException, ShopperContextException

Property Summary 

PropertyDescription
causeFullName: StringIf the exception is associated with a root cause, the property contains the full name of the associated Java exception.
causeMessage: StringIf the exception is associated with a root cause, the property contains the message of the associated Java exception.
causeName: StringIf the exception is associated with a root cause, the property contains the simplified name of the associated Java exception.
javaFullName: StringThe full name of the underlying Java exception.
javaMessage: StringThe message of the underlying Java exception.
javaName: StringThe simplified name of the underlying Java exception.
type: StringThe name of the actual APIException type, without the package name.

Constructor Summary 

ConstructorDescription
APIException()

Method Summary 

Methods inherited from class Error 

captureStackTrace, toString

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

causeFullName 

causeFullName: String

If the exception is associated with a root cause, the property contains the full name of the associated Java exception.


causeMessage 

causeMessage: String

If the exception is associated with a root cause, the property contains the message of the associated Java exception.


causeName 

causeName: String

If the exception is associated with a root cause, the property contains the simplified name of the associated Java exception.


javaFullName 

javaFullName: String

The full name of the underlying Java exception.


javaMessage 

javaMessage: String

The message of the underlying Java exception.


javaName 

javaName: String

The simplified name of the underlying Java exception.


type 

type: String

The name of the actual APIException type, without the package name.


Constructor Details 

APIException() 

APIException()