com.sap.tc.cmi.exception

Class CMIException

java.lang.Object
  BaseException
      com.sap.tc.cmi.exception.CMIException

public class CMIException
extends BaseException

Base class for checked exceptions thrown by methods of the Common Model Interface. It extends com.sap.exception.BaseException. For further information see there.

This type can be called or extended by applications or frameworks using CMI.

Type Classification:

This class is part of the Common Model Interface and is intended to be subclassed by applications.

Constructor Summary

CMIException(String messageText)
Creates an exception with a unparameterized text only.

CMIException(String messageText, Object[] parameters)
Creates an exception with the given messageText and text parameters.

CMIException(String messageText, Object[] parameters, Throwable cause)
Creates an exception with the given text, parameters and cause.

CMIException(String messageText, Throwable cause)
Creates an exception with the given (unparameterized) text and cause.

CMIException(Throwable cause)
Creates an exception with the given cause.

Method Summary

Object[]

getParameters() Returns the array of parameters that are part of the message text or null if there are no parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CMIException

public CMIException(String messageText)

Creates an exception with a unparameterized text only. The cause and parameters are set to null.

CMIException

public CMIException(String messageText,
                    Throwable cause)

Creates an exception with the given (unparameterized) text and cause. The parameters are set to null.

CMIException

public CMIException(Throwable cause)

Creates an exception with the given cause.

CMIException

public CMIException(String messageText,
                    Object[] parameters)

Creates an exception with the given messageText and text parameters.

See Also:

MessageFormat

CMIException

public CMIException(String messageText,
                    Object[] parameters,
                    Throwable cause)

Creates an exception with the given text, parameters and cause. This is the default constructor for this class.

Method Detail

getParameters

public Object[] getParameters()

Returns the array of parameters that are part of the message text or null if there are no parameters.