Enterprise Information Portal APIs

com.ibm.mm.beans
Class CMBException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ibm.mm.beans.CMBException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CMBChangePasswordFailedException, CMBConnectFailedException, CMBCursorNotValidException, CMBInvalidQueryException, CMBInvalidVersionException, CMBItemNotExistException, CMBItemNotSetException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBNoContentException, CMBServerAccessErrorException, CMBUserAlreadyExistException

public class CMBException
extends java.lang.Exception
implements java.io.Serializable

Base class of all exceptions raised by the beans.

Since:
6.1
See Also:
Serialized Form

Field Summary
static int CMB_ERR_ATTR_ALREADY_EXIST
          errorId value - item attribute already exist, errorData contains the attribute name
static int CMB_ERR_ATTR_INVALID_VALUE
          errorId value - item attribute value is invalid
static int CMB_ERR_ATTR_NOT_EXIST
          errorId value - item attribute does not exist, errorData contains the attribute name
static int CMB_ERR_CONNECT_FAILED
          errorId value - connect failed, errorData contains server name
static int CMB_ERR_CONNECTION_NOT_SET
          errorId value - CMBConnection bean is not set
static int CMB_ERR_CURSOR_NOT_VALID
          errorId value - cursor is not valid
static int CMB_ERR_ENTITY_NOT_SET
          errorId value - entity name is not set
static int CMB_ERR_ICM_DOC_ROUTING_EXCEPTION
          errorId value - icm document routing error
static int CMB_ERR_IKF_SERVER_EXCEPTION
          errorId value - ikf server error, errorData contains original Exception object
static int CMB_ERR_INVALID_METHOD
          errorId value - invalid method invoked on the given object
static int CMB_ERR_INVALID_QUERY
          errorId value - invalid query
static int CMB_ERR_INVALID_VERSION
          errorId value - item version is invalid
static int CMB_ERR_ITEM_NOT_EXIST
          errorId value - item does not exist, errorData contains the item object/item pid
static int CMB_ERR_ITEM_NOT_RETRIEVED
          errorId value - item not yet retrieved from server
static int CMB_ERR_ITEM_NOT_SET
          errorId value - item not yet set
static int CMB_ERR_RESULTS_INVALID
          errorId value - results invalid, errorData contains original Exception object
static int CMB_ERR_SEARCH_IN_PROGRESS
          errorId value - search is still in progress
static int CMB_ERR_SERVER_EXCEPTION
          errorId value - server error, errorData contains original Exception object
static int CMB_ERR_TEMPLATE_NOT_EXIST
          errorId value - template not exist
static int CMB_ERR_UNKNOWN
          errorId value - unknown errorId
static int CMB_ERR_WF_SERVER_EXCEPTION
          errorId value - wf server doesn't exist or wf server error, errorData contains original Exception object
 
Constructor Summary
CMBException(java.lang.String message)
          Constructs a CMBException Exception
CMBException(java.lang.String message, int errorId)
          Constructs a CMBException Exception
CMBException(java.lang.String message, int errorId, java.lang.Object errorData)
          Constructs a CMBException Exception
CMBException(java.lang.String message, int errorId, java.lang.Object errorData, java.lang.Object errorExtraData)
          Constructs a CMBException Exception
 
Method Summary
 java.lang.Object getErrorData()
          Get error data.
 java.lang.Object getErrorExtraData()
          Get error extra data
 int getErrorId()
          Get error Identifier
 java.lang.String name()
          Get Exception name
 void printStackTrace()
          Overridden to print stack of underlying exception if any.
 void printStackTrace(java.io.PrintStream s)
          Overridden to print stack of underlying exception if any.
 void printStackTrace(java.io.PrintWriter s)
          Overridden to print stack of underlying exception if any.
 void setErrorData(java.lang.Object errorData)
          Set error data.
 void setErrorExtraData(java.lang.Object errorExtraData)
          Set error extra data
 void setErrorId(int errorId)
          Set error Identifier
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CMB_ERR_UNKNOWN

public static final int CMB_ERR_UNKNOWN
errorId value - unknown errorId

CMB_ERR_ITEM_NOT_SET

public static final int CMB_ERR_ITEM_NOT_SET
errorId value - item not yet set

CMB_ERR_CURSOR_NOT_VALID

public static final int CMB_ERR_CURSOR_NOT_VALID
errorId value - cursor is not valid

CMB_ERR_CONNECT_FAILED

public static final int CMB_ERR_CONNECT_FAILED
errorId value - connect failed, errorData contains server name

CMB_ERR_CONNECTION_NOT_SET

public static final int CMB_ERR_CONNECTION_NOT_SET
errorId value - CMBConnection bean is not set

CMB_ERR_SEARCH_IN_PROGRESS

public static final int CMB_ERR_SEARCH_IN_PROGRESS
errorId value - search is still in progress

CMB_ERR_ENTITY_NOT_SET

public static final int CMB_ERR_ENTITY_NOT_SET
errorId value - entity name is not set

CMB_ERR_INVALID_METHOD

public static final int CMB_ERR_INVALID_METHOD
errorId value - invalid method invoked on the given object

CMB_ERR_ITEM_NOT_RETRIEVED

public static final int CMB_ERR_ITEM_NOT_RETRIEVED
errorId value - item not yet retrieved from server

CMB_ERR_ATTR_ALREADY_EXIST

public static final int CMB_ERR_ATTR_ALREADY_EXIST
errorId value - item attribute already exist, errorData contains the attribute name

CMB_ERR_ATTR_NOT_EXIST

public static final int CMB_ERR_ATTR_NOT_EXIST
errorId value - item attribute does not exist, errorData contains the attribute name

CMB_ERR_ITEM_NOT_EXIST

public static final int CMB_ERR_ITEM_NOT_EXIST
errorId value - item does not exist, errorData contains the item object/item pid

CMB_ERR_SERVER_EXCEPTION

public static final int CMB_ERR_SERVER_EXCEPTION
errorId value - server error, errorData contains original Exception object

CMB_ERR_RESULTS_INVALID

public static final int CMB_ERR_RESULTS_INVALID
errorId value - results invalid, errorData contains original Exception object

CMB_ERR_TEMPLATE_NOT_EXIST

public static final int CMB_ERR_TEMPLATE_NOT_EXIST
errorId value - template not exist

CMB_ERR_WF_SERVER_EXCEPTION

public static final int CMB_ERR_WF_SERVER_EXCEPTION
errorId value - wf server doesn't exist or wf server error, errorData contains original Exception object

CMB_ERR_INVALID_QUERY

public static final int CMB_ERR_INVALID_QUERY
errorId value - invalid query

CMB_ERR_ATTR_INVALID_VALUE

public static final int CMB_ERR_ATTR_INVALID_VALUE
errorId value - item attribute value is invalid

CMB_ERR_INVALID_VERSION

public static final int CMB_ERR_INVALID_VERSION
errorId value - item version is invalid
Since:
8.1

CMB_ERR_ICM_DOC_ROUTING_EXCEPTION

public static final int CMB_ERR_ICM_DOC_ROUTING_EXCEPTION
errorId value - icm document routing error

CMB_ERR_IKF_SERVER_EXCEPTION

public static final int CMB_ERR_IKF_SERVER_EXCEPTION
errorId value - ikf server error, errorData contains original Exception object
Constructor Detail

CMBException

public CMBException(java.lang.String message)
Constructs a CMBException Exception
Parameters:
message - message text

CMBException

public CMBException(java.lang.String message,
                    int errorId)
Constructs a CMBException Exception
Parameters:
message - message text
errorId - error id

CMBException

public CMBException(java.lang.String message,
                    int errorId,
                    java.lang.Object errorData)
Constructs a CMBException Exception
Parameters:
message - message text
errorId - error id
errorData - error data

CMBException

public CMBException(java.lang.String message,
                    int errorId,
                    java.lang.Object errorData,
                    java.lang.Object errorExtraData)
Constructs a CMBException Exception
Parameters:
message - message text
errorId - error id
errorData - error data
errorExtraData - extra error data
Method Detail

getErrorData

public java.lang.Object getErrorData()
Get error data. When the CMBException is wrapping an underlying exception from the Java API, this returns the underlying exception.
Returns:
error data

getErrorExtraData

public java.lang.Object getErrorExtraData()
Get error extra data
Returns:
error extra data

setErrorData

public void setErrorData(java.lang.Object errorData)
Set error data.
Parameters:
errorData - error data

setErrorExtraData

public void setErrorExtraData(java.lang.Object errorExtraData)
Set error extra data
Parameters:
errorExtraData - error extra data

name

public java.lang.String name()
Get Exception name
Returns:
Exception name

getErrorId

public int getErrorId()
Get error Identifier
Returns:
error Id

setErrorId

public void setErrorId(int errorId)
Set error Identifier
Parameters:
errorId - error Id

printStackTrace

public void printStackTrace()
Overridden to print stack of underlying exception if any.
Overrides:
printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream s)
Overridden to print stack of underlying exception if any.
Overrides:
printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter s)
Overridden to print stack of underlying exception if any.
Overrides:
printStackTrace in class java.lang.Throwable

EIP JavaBeans

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.