com.ibm.commerce.marketing.facade.client

Class CampaignException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

com.ibm.commerce.marketing.facade.client.CampaignException

All Implemented Interfaces:

java.io.Serializable

public class CampaignException
extends AbstractBusinessObjectDocumentException

This exception represents a business error about why the request was not processed 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 during processing instead of having to examine the result returned from the Campaign facade.

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
CampaignException(ChangeStatusType changeStatus, VerbType verb, java.util.List campaigns) Creates an instance of the Campaign exception.
CampaignException(java.util.List clientErrors) Creates an instance of the Campaign exception.

Method Summary

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

CampaignException

public CampaignException(ChangeStatusType changeStatus,
                         VerbType verb,
                         java.util.List campaigns)

Creates an instance of the Campaign exception.

Parameters:

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

verb - The returning verb.

campaigns - The list of Campaign that is associated with the response.

CampaignException

public CampaignException(java.util.List clientErrors)

Creates an instance of the Campaign exception.

Parameters:

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

Method Detail

getCampaign

public java.util.List getCampaign()

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

Returns:

The list of Campaign found in the response.