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

Class AbstractBusinessObjectDocumentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ActivityException, AttachmentException, CampaignElementTemplateException, CampaignException, CatalogEntryException, CatalogEntryInstallmentPriceException, CatalogException, CatalogGroupException, ClientLocationException, ConfigurationException, ContractException, GeoNodeException, GiftCenterException, InstallmentRuleException, InventoryAvailabilityException, InventoryRequirementException, KitException, LayoutException, ManagedDirectoryException, ManagedFileException, MarketingContentException, MarketingEmailTemplateException, MarketingSpotDataException, MarketingSpotException, MarketingTriggerException, MemberGroupException, OnlineStoreException, OrderException, OrderInstallmentPriceException, OrganizationException, PageDesignException, PageException, PersonException, PhysicalStoreException, PointOfInterestException, PromotionException, QuoteException, SearchTermAssociationException, SubscriptionException, WalletException, WalletItemException, WidgetDefinitionException

public abstract class AbstractBusinessObjectDocumentException
extends java.lang.Exception

This abstract class should be the basis for all exceptions that a component client will throw. This exception class understands the recommended practice for representing exceptions. Any business object document client is recommended to throw exceptions which extend this class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANGE_STATUS_CODE_VALUE_FOR_ERROR The constant found in the change status code which indicates an error.
static java.lang.String	ERROR_COUNT The error count message, used when the resource bundle isn't available.
static java.lang.String	ERROR_COUNT_KEY The error count message key.
static java.lang.String	MESSAGEKEY_ERRORCODE_SEPARATOR The separator for message key and error code

Constructor Summary

Constructors

Constructor and Description
AbstractBusinessObjectDocumentException(ChangeStatusType aChangeStatus, VerbType verb, java.util.List nouns) Creates an instance of the business object document exception.
AbstractBusinessObjectDocumentException(java.util.List clientErrors) Creates an instance of the business object document exception.

Method Summary

Modifier and Type	Method and Description
void	addClientError(ClientError clientError) This method adds a client error to the existing client errors that are part of the exception.
ChangeStatusType	getChangeStatus() Returns the change status information associated with the exception.
java.util.List	getClientErrors() This method returns the list of client errors associated with the exception.
java.lang.String	getLocalizedMessage() Get the localized exception message.
java.lang.String	getMessage() Get the exception message.
VerbType	getVerb() Returns the verb in the response document.

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

Field Detail

ERROR_COUNT_KEY

public static final java.lang.String ERROR_COUNT_KEY

The error count message key.

See Also:

Constant Field Values

ERROR_COUNT

public static final java.lang.String ERROR_COUNT

The error count message, used when the resource bundle isn't available.

See Also:

Constant Field Values

MESSAGEKEY_ERRORCODE_SEPARATOR

public static final java.lang.String MESSAGEKEY_ERRORCODE_SEPARATOR

The separator for message key and error code

See Also:

Constant Field Values

CHANGE_STATUS_CODE_VALUE_FOR_ERROR

public static final java.lang.String CHANGE_STATUS_CODE_VALUE_FOR_ERROR

The constant found in the change status code which indicates an error.

See Also:

Constant Field Values

Constructor Detail

AbstractBusinessObjectDocumentException

public AbstractBusinessObjectDocumentException(ChangeStatusType aChangeStatus,
                                               VerbType verb,
                                               java.util.List nouns)

Creates an instance of the business object document exception.

Parameters:

aChangeStatus - The change status object that contains the exception information.

verb - The verb of the response.

nouns - The nouns associated with the response which may indicate more information about the exception.

AbstractBusinessObjectDocumentException

public AbstractBusinessObjectDocumentException(java.util.List clientErrors)

Creates an instance of the business object document 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

getMessage

public java.lang.String getMessage()

Get the exception message.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the exception message.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Get the localized exception message.

Overrides:

getLocalizedMessage in class java.lang.Throwable

Returns:

the localized exception message.

addClientError

public void addClientError(ClientError clientError)

This method adds a client error to the existing client errors that are part of the exception.

Parameters:

clientError - The client error to add to the exception.

getClientErrors

public java.util.List getClientErrors()

This method returns the list of client errors associated with the exception.

Returns:

The list of client errors with the exception.

getChangeStatus

public ChangeStatusType getChangeStatus()

Returns the change status information associated with the exception.

Returns:

The change status information.

getVerb

public VerbType getVerb()

Returns the verb in the response document.

Returns:

The verb in the response document.