com.ibm.commerce.subscription.facade.client

Class SubscriptionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

com.ibm.commerce.subscription.facade.client.SubscriptionException

All Implemented Interfaces:

java.io.Serializable

public class SubscriptionException
extends AbstractBusinessObjectDocumentException

This exception represents a business error describing why the request failed. This exception is thrown when the Subscription service returns error information.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.

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
SubscriptionException(ChangeStatusType changeStatus, VerbType verb, java.util.List subscriptions) Creates an instance of the Subscription exception.
SubscriptionException(java.util.List clientErrors) Creates an instance of the Subscription exception.
SubscriptionException(java.lang.String key, java.lang.String value) Creates an instance of the Subscription exception with the error key and value.

Method Summary

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

Constructor Detail

SubscriptionException

public SubscriptionException(ChangeStatusType changeStatus,
                             VerbType verb,
                             java.util.List subscriptions)

Creates an instance of the Subscription exception.

Parameters:

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

verb - The returning verb.

subscriptions - The list of Subscription that is associated with the response.

SubscriptionException

public SubscriptionException(java.util.List clientErrors)

Creates an instance of the Subscription exception.

Parameters:

clientErrors - The client errors to associate with the exception. These client error represent client side parameter validation that cause the exception.

SubscriptionException

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

Creates an instance of the Subscription exception with the error key and value.

Parameters:

key - The name of the parameter which caused the exception

value - The parameter value which caused the exception

Method Detail

getSubscription

public java.util.List getSubscription()

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

Returns:

The list of Subscription found in the response.