com.ibm.commerce.infrastructure.facade.client

Class ConfigurationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

com.ibm.commerce.infrastructure.facade.client.ConfigurationException

All Implemented Interfaces:

java.io.Serializable

public class ConfigurationException
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 Configuration 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
ConfigurationException(ChangeStatusType changeStatus, VerbType verb, java.util.List configurations) Creates an instance of the Configuration exception.
ConfigurationException(java.util.List clientErrors) Creates an instance of the Configuration exception.

Method Summary

Modifier and Type	Method and Description
java.util.List	getConfiguration() Returns the Configuration 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

ConfigurationException

public ConfigurationException(ChangeStatusType changeStatus,
                              VerbType verb,
                              java.util.List configurations)

Creates an instance of the Configuration exception.

Parameters:

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

verb - The returning verb.

configurations - The list of Configuration that is associated with the response.

ConfigurationException

public ConfigurationException(java.util.List clientErrors)

Creates an instance of the Configuration 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

getConfiguration

public java.util.List getConfiguration()

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

Returns:

The list of Configuration found in the response.