com.filenet.rm.bds.exception

Class BDSException

  1. java.lang.Object
  2. extended byjava.lang.Throwable
  3. extended byjava.lang.Exception
  4. extended byjava.lang.RuntimeException
  5. extended bycom.filenet.rm.bds.exception.BDSException
All implemented interfaces:
java.io.Serializable

  1. public class BDSException
  2. extends java.lang.RuntimeException
BDSException is the main exception thrown by the public BDS API entry points.
See Also:
Serialized Form

Constructor Summary

Constructor and Description
BDSException(ErrorCode errorCode)
Constructor.
BDSException(ErrorCode errorCode,ErrorStack errorStack)
Constructor.
BDSException(ErrorCode errorCode,ErrorStack errorStack,java.lang.Object arg0)
Constructor.
BDSException(ErrorCode errorCode,ErrorStack errorStack,java.lang.Object[] args)
Constructor.
BDSException(ErrorCode errorCode,ErrorStack errorStack,java.lang.Object arg0,java.lang.Object arg1)
Constructor.
BDSException(ErrorCode errorCode,ErrorStack errorStack,java.lang.Object arg0,java.lang.Object arg1,java.lang.Object arg2)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Object arg0)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Object[] args)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Object arg0,java.lang.Object arg1)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Object arg0,java.lang.Object arg1,java.lang.Object arg2)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Throwable cause)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Throwable cause,ErrorStack errorStack)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Throwable cause,ErrorStack errorStack,java.lang.Object arg0)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Throwable cause,ErrorStack errorStack,java.lang.Object arg0,java.lang.Object arg1)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Throwable cause,java.lang.Object arg0)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Throwable cause,java.lang.Object[] args)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Throwable cause,java.lang.Object arg0,java.lang.Object arg1)
Constructor.
BDSException(ErrorCode errorCode,java.lang.Throwable cause,java.lang.Object arg0,java.lang.Object arg1,java.lang.Object arg2)
Constructor.

Method Summary

Modifier and Type Method and Description
  1. java.lang.StringBuffer
dumpBDSException(int logDetail,java.lang.StringBuffer inputBuffer)
Dumps textual information concerning a BDSExcpeption into the form of a StringBuffer.
  1. java.lang.StringBuffer
dumpBDSException(java.lang.StringBuffer inputBuffer)
Dumps textual information concerning a BDSExcpeption into the form of a StringBuffer.
  1. ErrorCode
getErrorCode()
Returns the ErrorCodeconstant associated with this BDSException instance.
  1. ErrorStack
getErrorStack()
Returns the ErrorStackinstance associated with this BDSException instance.
  1. java.lang.String
getLocalizedMessage()
  1. java.lang.String
getLocalizedMessage(java.util.Locale locale)
Returns message string localized for the specified Locale.
  1. static
  2. void
setLogDetail(int logDetail)
Sets static log detail level for the BDSException class.
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BDSException

  1. public BDSException(ErrorCode errorCode)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Object arg0)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
arg0 - 1st argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Object arg0,
  3. java.lang.Object arg1)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
arg0 - 1st argument to be applied to the formatting of the error msg string.
arg1 - 2nd argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Object arg0,
  3. java.lang.Object arg1,
  4. java.lang.Object arg2)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
arg0 - 1st argument to be applied to the formatting of the error msg string.
arg1 - 2nd argument to be applied to the formatting of the error msg string.
arg2 - 3rd argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Object[] args)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
args - Arguments to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Throwable cause)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
cause - the underlying Throwable exception chain.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Throwable cause,
  3. java.lang.Object arg0)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
cause - the underlying Throwable exception chain.
arg0 - 1st argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Throwable cause,
  3. java.lang.Object arg0,
  4. java.lang.Object arg1)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
cause - the underlying Throwable exception chain.
arg0 - 1st argument to be applied to the formatting of the error msg string.
arg1 - 2nd argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Throwable cause,
  3. java.lang.Object arg0,
  4. java.lang.Object arg1,
  5. java.lang.Object arg2)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
cause - the underlying Throwable exception chain.
arg0 - 1st argument to be applied to the formatting of the error msg string.
arg1 - 2nd argument to be applied to the formatting of the error msg string.
arg2 - 3rd argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Throwable cause,
  3. java.lang.Object[] args)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
cause - the underlying Throwable exception chain.
args - Arguments to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. ErrorStack errorStack)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
errorStack - the ErrorStack object to associated with this BDSException.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Throwable cause,
  3. ErrorStack errorStack)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
cause - the underlying Throwable exception chain.
errorStack - the ErrorStack object to associated with this BDSException.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. ErrorStack errorStack,
  3. java.lang.Object arg0)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
errorStack - the ErrorStack object to associated with this BDSException.
arg0 - 1st argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Throwable cause,
  3. ErrorStack errorStack,
  4. java.lang.Object arg0)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
cause - the underlying Throwable exception chain.
errorStack - the ErrorStack object to associated with this BDSException.
arg0 - 1st argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. ErrorStack errorStack,
  3. java.lang.Object arg0,
  4. java.lang.Object arg1)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
errorStack - the ErrorStack object to associated with this BDSException.
arg0 - 1st argument to be applied to the formatting of the error msg string.
arg1 - 2nd argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. java.lang.Throwable cause,
  3. ErrorStack errorStack,
  4. java.lang.Object arg0,
  5. java.lang.Object arg1)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
cause - the underlying Throwable exception chain.
errorStack - the ErrorStack object to associated with this BDSException.
arg0 - 1st argument to be applied to the formatting of the error msg string.
arg1 - 2nd argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. ErrorStack errorStack,
  3. java.lang.Object arg0,
  4. java.lang.Object arg1,
  5. java.lang.Object arg2)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
errorStack - the ErrorStack object to associated with this BDSException.
arg0 - 1st argument to be applied to the formatting of the error msg string.
arg1 - 2nd argument to be applied to the formatting of the error msg string.
arg2 - 3rd argument to be applied to the formatting of the error msg string.

BDSException

  1. public BDSException(ErrorCode errorCode,
  2. ErrorStack errorStack,
  3. java.lang.Object[] args)
Constructor.
Parameters:
errorCode - the ErrorCode constant to associate with this BDSException.
errorStack - the ErrorStack object to associated with this BDSException.
args - Arguments to be applied to the formatting of the error msg string.

Method Detail

getLocalizedMessage

  1. public java.lang.String getLocalizedMessage( )
Overrides:
getLocalizedMessage in class java.lang.Throwable

getLocalizedMessage

  1. public java.lang.String getLocalizedMessage( java.util.Locale locale)
Returns message string localized for the specified Locale.
Parameters:
locale - the Locale in question.
Returns:
message String localized for given Locale

getErrorCode

  1. public ErrorCode getErrorCode()
Returns the ErrorCode constant associated with this BDSException instance.
Returns:
an ErrorCode constant.

getErrorStack

  1. public ErrorStack getErrorStack( )
Returns the ErrorStack instance associated with this BDSException instance.
Returns:
an ErrorStack stance. Can be null.

setLogDetail

  1. public static void setLogDetail( int logDetail)
Sets static log detail level for the BDSException class.
Parameters:
logDetail - new log detial level (see ConfigItemType.EXCEPTION_LOGGING_DETAIL).

dumpBDSException

  1. public java.lang.StringBuffer dumpBDSException( java.lang.StringBuffer inputBuffer)
Dumps textual information concerning a BDSExcpeption into the form of a StringBuffer. Uses current BDSException static logging level setting.
Parameters:
inputBuffer - an existing StringBuffer to append this BDSException information. If null a new StringBuffer will be allocated.
Returns:
StringBuffer containing textual information about this BDSException. The returned StringBuffer is the same instance passed in as the inputBuffer parameter or any automatically allocated instance.

dumpBDSException

  1. public java.lang.StringBuffer dumpBDSException( int logDetail,
  2. java.lang.StringBuffer inputBuffer)
Dumps textual information concerning a BDSExcpeption into the form of a StringBuffer.
Parameters:
logDetail - int value indicating level of detail to include. See ConfigItemType.EXCEPTION_LOGGING_DETAIL.
inputBuffer - an existing StringBuffer to append this BDSException information. If null a new StringBuffer will be allocated.
Returns:
StringBuffer containing textual information about this BDSException. The returned StringBuffer is the same instance passed in as the inputBuffer parameter or any automatically allocated instance.