com.ibm.commerce.contract.facade.client

Class ContractException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

com.ibm.commerce.contract.facade.client.ContractException

All Implemented Interfaces:

java.io.Serializable

public class ContractException
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 instead of having to examine the result returned from the Contract 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
ContractException(ChangeStatusType changeStatus, VerbType verb, java.util.List contracts) Creates an instance of the Contract exception.
ContractException(java.util.List clientErrors) This is the constructor of the class.

Method Summary

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

ContractException

public ContractException(ChangeStatusType changeStatus,
                         VerbType verb,
                         java.util.List contracts)

Creates an instance of the Contract exception.

Parameters:

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

verb - The returning verb

contracts - The list of Contract that is associated with the response

ContractException

public ContractException(java.util.List clientErrors)

This is the constructor of the class.

Parameters:

clientErrors - the list of client errors

Method Detail

getContract

public java.util.List getContract()

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

Returns:

The list of contracts found in the response