com.ibm.commerce.context.exception

Class BusinessContextServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.commerce.component.exception.ServiceException

com.ibm.commerce.context.exception.BusinessContextServiceException

All Implemented Interfaces:

com.ibm.commerce.exception.ECCorrelatedIdentity, java.io.Serializable

Direct Known Subclasses:

BusinessContextException, BusinessContextNotFoundException, BusinessContextServiceAuthenticationException, BusinessContextServiceInitException, InvalidActivityTokenException

public class BusinessContextServiceException
extends ServiceException

The exception to be thrown when an error is encountered in a context service.

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
BusinessContextServiceException() The zero-argument constructor.
BusinessContextServiceException(ECMessage message, java.lang.String strClassName, java.lang.String strMethodName, java.lang.String[] msgParams) Constructs a BusinessContextServiceException with the specified parameters.
BusinessContextServiceException(ECMessage message, java.lang.String strClassName, java.lang.String strMethodName, java.lang.String[] msgParams, java.lang.Throwable throwable) Constructs a BusinessContextServiceException with the specified parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassname() Gets the name of the class that is throwing this exception.
ECMessage	getECMessage() Gets the message that describes this exception.
java.lang.String	getLocalizedMessage() Gets the localized message that describes this exception.
java.lang.String	getMessage() Gets the localized message that describes this exception.
java.lang.String[]	getMessageParameters() Gets the parameters that the message requires.
java.lang.String	getMethodName() Gets the name of the method that is throwing this exception.
long	getReasonCode() Gets the reason code.
void	logException() Logs this exception.
void	setClassname(java.lang.String string) Sets the name of the class that is throwing this exception.
void	setECMessage(ECMessage message) Sets the message that describes this exception.
void	setMessageParameters(java.lang.String[] strings) Sets the parameters that the message requires.
void	setMethodName(java.lang.String string) Sets the name of the method that is throwing this exception.

Methods inherited from class com.ibm.commerce.component.exception.ServiceException

getCorrelationIdentifier, getServiceParameterErrors, getSymptomData, isRecoverable, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, 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

BusinessContextServiceException

public BusinessContextServiceException()

The zero-argument constructor.

See Also:

ServiceException.ServiceException()

BusinessContextServiceException

public BusinessContextServiceException(ECMessage message,
                                       java.lang.String strClassName,
                                       java.lang.String strMethodName,
                                       java.lang.String[] msgParams)

Constructs a BusinessContextServiceException with the specified parameters.

Parameters:

ecMessage - a message that describes this exception

className - the name of the class that is throwing this exception (to be used for logging purposes)

methodName - the name of the method that is throwing this exception (to be used for logging purposes)

msgParams - the parameters that the message requires

BusinessContextServiceException

public BusinessContextServiceException(ECMessage message,
                                       java.lang.String strClassName,
                                       java.lang.String strMethodName,
                                       java.lang.String[] msgParams,
                                       java.lang.Throwable throwable)

Constructs a BusinessContextServiceException with the specified parameters.

Parameters:

ecMessage - a message that describes this exception

className - the name of the class that is throwing this exception (to be used for logging purposes)

methodName - the name of the method that is throwing this exception (to be used for logging purposes)

msgParams - the parameters that the message requires

throwable - the cause of this exception

Method Detail

getMessage

public java.lang.String getMessage()

Gets the localized message that describes this exception.

Overrides:

getMessage in class ServiceException

Returns:

the localized message

See Also:

Throwable.getMessage()

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Gets the localized message that describes this exception.

Overrides:

getLocalizedMessage in class ServiceException

Returns:

the localized message

See Also:

Throwable.getLocalizedMessage()

logException

public void logException()

Logs this exception.

getClassname

public java.lang.String getClassname()

Gets the name of the class that is throwing this exception.

Returns:

the name of the class

getECMessage

public ECMessage getECMessage()

Gets the message that describes this exception.

Returns:

the message

getMethodName

public java.lang.String getMethodName()

Gets the name of the method that is throwing this exception.

Returns:

the name of the method

getMessageParameters

public java.lang.String[] getMessageParameters()

Gets the parameters that the message requires.

Returns:

an array of the parameters

setClassname

public void setClassname(java.lang.String string)

Sets the name of the class that is throwing this exception.

Parameters:

string - the name of the class

setECMessage

public void setECMessage(ECMessage message)

Sets the message that describes this exception.

Parameters:

message - the message

setMethodName

public void setMethodName(java.lang.String string)

Sets the name of the method that is throwing this exception.

Parameters:

string - the name of the method

setMessageParameters

public void setMessageParameters(java.lang.String[] strings)

Sets the parameters that the message requires.

Parameters:

strings - an array of the parameters

getReasonCode

public long getReasonCode()

Gets the reason code.

Overrides:

getReasonCode in class ServiceException

Returns:

the reason code

See Also:

ServiceException.getReasonCode()