com.ibm.commerce.promotion.facade.client

Class PromotionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentException

com.ibm.commerce.promotion.facade.client.PromotionException

All Implemented Interfaces:

java.io.Serializable

public class PromotionException
extends AbstractBusinessObjectDocumentException

This exception represents a business error to why the request was not process sucessfully. This exception will include the response information so the call can examine the response. The purpose of the exception is a convient way for the client to be notified if there was an error when processing instead of having to examine the result returned from the Promotion facade.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentException

CHANGE_STATUS_CODE_VALUE_FOR_ERROR, ERROR_COUNT, ERROR_COUNT_KEY, MESSAGEKEY_ERRORCODE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
PromotionException(ChangeStatusType changeStatus, VerbType verb, java.util.List promotions) Creates an instance of the Promotion exception.
PromotionException(java.util.List clientErrors) Creates an instance of the Promotion exception.

Method Summary

Modifier and Type	Method and Description
java.util.List	getPromotion() Returns the Promotion that is associated with the response of the request.

Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentException

addClientError, getChangeStatus, getClientErrors, getLocalizedMessage, getMessage, getVerb

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PromotionException

public PromotionException(ChangeStatusType changeStatus,
                          VerbType verb,
                          java.util.List promotions)

Creates an instance of the Promotion exception.

Parameters:

changeStatus - The error information that is contained in the ChangeStatus element of the respond or acknowledge verb.

verb - The returning verb.

promotions - The list of Promotion that is associated with the response.

PromotionException

public PromotionException(java.util.List clientErrors)

Creates an instance of the Promotion exception.

Parameters:

clientErrors - The client errors to associate with the exception. These client error represent client side parameter validation that cause the exception.

Method Detail

getPromotion

public java.util.List getPromotion()

Returns the Promotion that is associated with the response of the request.

Returns:

The list of Promotion found in the response.