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

Class ClientError

java.lang.Object

com.ibm.commerce.foundation.common.exception.ApplicationError

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

All Implemented Interfaces:

java.io.Serializable

public class ClientError
extends ApplicationError

The client error object represents a particular error. When the caller specifies a series of invalid parameters, each invalid parameter is represented as client error.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.commerce.foundation.common.exception.ApplicationError

TYPE_GENERIC_ERROR, TYPE_INVALID_PARAMETER_VALUE, TYPE_MALFORMED_REQUEST, TYPE_MISSING_PARAMETER, TYPE_PARAMETER_VALUE_NOT_NUMERIC

Constructor Summary

Constructors

Constructor and Description
ClientError() Creates an instance of the client error object.
ClientError(short type, java.lang.String errorKey, java.lang.Object[] errorParameters, java.lang.String resourceBundleName) Creates an instance of the client error object.
ClientError(short type, java.lang.String errorKey, java.lang.String localizedMessage, java.lang.Object[] errorParameters, java.lang.String resourceBundleName, java.lang.String errorCode) Creates an instance of the client error object.

Method Summary

Methods inherited from class com.ibm.commerce.foundation.common.exception.ApplicationError

getErrorCode, getErrorKey, getErrorParameters, getLocale, getLocalizedMessage, getLocalizedMessage, getType, setErrorCode, setErrorKey, setErrorParameters, setLocale, setLocalizedMessage, setType, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientError

public ClientError()

Creates an instance of the client error object.

ClientError

public ClientError(short type,
                   java.lang.String errorKey,
                   java.lang.Object[] errorParameters,
                   java.lang.String resourceBundleName)

Creates an instance of the client error object.

Parameters:

type - The type of error that is being reported. Refer to the constants defined in this class.

errorKey - The error key associated with the error.

errorParameters - The error parameters to associated with the key.

resourceBundleName - The name of the resource bundle to find the key.

ClientError

public ClientError(short type,
                   java.lang.String errorKey,
                   java.lang.String localizedMessage,
                   java.lang.Object[] errorParameters,
                   java.lang.String resourceBundleName,
                   java.lang.String errorCode)

Creates an instance of the client error object.

Parameters:

type - The type of error that is being reported. Refer to the constants defined in this class.

errorKey - The error key associated with the error.

localizedMessage - The localized error message associated with the error.

errorParameters - The error parameters to associated with the key.

resourceBundleName - The name of the resource bundle to find the key.

errorCode - The error code to associate with the key.