com.ibm.commerce.edp.api

Class InvalidDataException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.commerce.edp.api.BaseException

com.ibm.commerce.edp.api.EDPException

com.ibm.commerce.edp.api.InputException

com.ibm.commerce.edp.api.InvalidDataException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

InvalidCreditException, InvalidPaymentException, InvalidPaymentInstructionException

public class InvalidDataException
extends InputException

This class represents the exception thrown when invalid parameters are provided in its interface or requested objects are in invalid state.

Invalid parameters can be null and out of the context range.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidDataException() Default Constructor.
InvalidDataException(java.lang.String resourceBundleName, java.lang.String messageKey, java.lang.Object[] formatArguments, java.lang.String defaultText) Constructor with a localized message.
InvalidDataException(java.lang.String resourceBundleName, java.lang.String messageKey, java.lang.Object[] formatArguments, java.lang.String defaultText, java.lang.Throwable exception) Constructor with a localized message and a chained exception.
InvalidDataException(java.lang.Throwable exception) Constructor with a chained exception.

Method Summary

Modifier and Type	Method and Description
java.lang.String	dumpException() This method converts exception into a human-readable format.
java.lang.String	getInvalidAttributeName() This method returns the name of the invalid attribute.
java.lang.String	getInvalidAttributeType() This method returns the type of the invalid attribute.
java.lang.String	getInvalidAttributeValue() This method returns the value of the invalid attribute.
void	setInvalidAttributeName(java.lang.String localInvalidAttributeName) This method sets the name of the invalid attribute.
void	setInvalidAttributeType(java.lang.String localInvalidAttributeType) This method sets the type of the invalid attribute.
void	setInvalidAttributeValue(java.lang.Object localInvalidAttributeValue) This method sets the value of the invalid attribute.

Methods inherited from class com.ibm.commerce.edp.api.BaseException

addProperties, addProperties, addProperty, getClassSource, getDefaultMessage, getFormatArguments, getLocalizedMessage, getLocalizedMessage, getMessage, getMessageKey, getMethodSource, getPreviousException, getProperties, getResourceBundleName, setClassSource, setDefaultMessage, setFormatArguments, setMessageKey, setMethodSource, setPreviousException, setProperties, setResourceBundleName

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

InvalidDataException

public InvalidDataException()

Default Constructor.

InvalidDataException

public InvalidDataException(java.lang.String resourceBundleName,
                            java.lang.String messageKey,
                            java.lang.Object[] formatArguments,
                            java.lang.String defaultText)

Constructor with a localized message.

Parameters:

resourceBundleName - the name of the resource bundle to be used to generate a localized exception message

messageKey - the key to identify the resource to generate a localized exception

formatArguments - an array of arguments to build the localized message

defaultText - the message that is shown if the localized message cannot be generated

InvalidDataException

public InvalidDataException(java.lang.String resourceBundleName,
                            java.lang.String messageKey,
                            java.lang.Object[] formatArguments,
                            java.lang.String defaultText,
                            java.lang.Throwable exception)

Constructor with a localized message and a chained exception.

Parameters:

resourceBundleName - the name of the resource bundle to be used to generate a localized exception message

messageKey - the key to identify the resource to generate a localized exception

formatArguments - an array of arguments to build the localized message

defaultText - the message that is shown if the localized message cannot be generated

exception - the exception to be chained

InvalidDataException

public InvalidDataException(java.lang.Throwable exception)

Constructor with a chained exception.

Parameters:

exception - the exception to be chained

Method Detail

setInvalidAttributeName

public void setInvalidAttributeName(java.lang.String localInvalidAttributeName)

This method sets the name of the invalid attribute.

Parameters:

localInvalidAttributeName - the name of the invalid attribute

getInvalidAttributeName

public java.lang.String getInvalidAttributeName()

This method returns the name of the invalid attribute.

Returns:

The name of the invalid attribute

setInvalidAttributeType

public void setInvalidAttributeType(java.lang.String localInvalidAttributeType)

This method sets the type of the invalid attribute.

Parameters:

localInvalidAttributeType - the type of the invalid attribute

getInvalidAttributeType

public java.lang.String getInvalidAttributeType()

This method returns the type of the invalid attribute.

Returns:

The type of the invalid attribute

setInvalidAttributeValue

public void setInvalidAttributeValue(java.lang.Object localInvalidAttributeValue)

This method sets the value of the invalid attribute.

Parameters:

localInvalidAttributeValue - the value of the invalid attribute

getInvalidAttributeValue

public java.lang.String getInvalidAttributeValue()

This method returns the value of the invalid attribute.

Returns:

The value of the invalid attribute

dumpException

public java.lang.String dumpException()

This method converts exception into a human-readable format.

Overrides:

dumpException in class BaseException

Returns:

a human-readable text describing the exception and its details