com.ibm.commerce.catalog.facade.client

Class CatalogException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

com.ibm.commerce.catalog.facade.client.CatalogException

All Implemented Interfaces:

java.io.Serializable

public class CatalogException
extends AbstractBusinessObjectDocumentException

This exception will be thrown when an error happens while performing a Process operation on a single Catalog. The exception will include the response information and the associated list of catalogs for the call to examine. The purpose of the exception is a convenient way for the client to be notified if there was an error when processing instead of having to examine the result returned from the Catalog 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
CatalogException(ChangeStatusType changeStatus, VerbType verb, java.util.List catalogs) Creates an instance of the Catalog exception.
CatalogException(java.util.List clientErrors) Creates an instance of the Catalog exception.

Method Summary

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

CatalogException

public CatalogException(ChangeStatusType changeStatus,
                        VerbType verb,
                        java.util.List catalogs)

Creates an instance of the Catalog exception.

Parameters:

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

verb - The returning verb.

catalogs - The list of Catalog that is associated with the response.

CatalogException

public CatalogException(java.util.List clientErrors)

Creates an instance of the Catalog exception.

Parameters:

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

Method Detail

getCatalog

public java.util.List getCatalog()

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

Returns:

The list of catalogs found in the response.