com.ibm.commerce.order.facade.client

Class OrderException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

com.ibm.commerce.order.facade.client.OrderException

All Implemented Interfaces:

java.io.Serializable

public class OrderException
extends AbstractBusinessObjectDocumentException

This exception represents a business error to why the request was not process successfully. This exception will include the response information so the call can examine the response. The purpose of the exception is a convenient way for the client to be notified if there was an error when processing. Then it is no need to examine the result returned from the Order 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
OrderException(ChangeStatusType changeStatus, VerbType verb, java.util.List orders) This method creates an instance of the Order exception.
OrderException(java.util.List clientErrors) This is the constructor of the class.
OrderException(java.lang.String key, java.lang.String value) This method is a construction of the class

Method Summary

Modifier and Type	Method and Description
java.util.List	getOrder() This method returns the orders that are 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

OrderException

public OrderException(ChangeStatusType changeStatus,
                      VerbType verb,
                      java.util.List orders)

This method creates an instance of the Order exception.

Parameters:

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

verb - The returning verb.

orders - The list of Order that is associated with the response.

OrderException

public OrderException(java.util.List clientErrors)

This is the constructor of the class.

Parameters:

clientErrors - the list of client errors.

OrderException

public OrderException(java.lang.String key,
                      java.lang.String value)

This method is a construction of the class

Parameters:

key - the message key

value - the message value

Method Detail

getOrder

public java.util.List getOrder()

This method returns the orders that are associated with the response of the request.

Returns:

The list of orders found in the response.