com.filenet.rm.bds.exception

Class BDSException

  • java.lang.Object
    • java.lang.Throwable
      • java.lang.Exception
        • java.lang.RuntimeException
          • com.filenet.rm.bds.exception.BDSException
  • All Implemented Interfaces:
    java.io.Serializable


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

      Methods 
      Modifier and Type Method and Description
      java.lang.StringBuffer dumpBDSException(int logDetail, java.lang.StringBuffer inputBuffer)
      Dumps textual information concerning a BDSExcpeption into the form of a StringBuffer.
      java.lang.StringBuffer dumpBDSException(java.lang.StringBuffer inputBuffer)
      Dumps textual information concerning a BDSExcpeption into the form of a StringBuffer.
      ErrorCode getErrorCode()
      Returns the ErrorCode constant associated with this BDSException instance.
      ErrorStack getErrorStack()
      Returns the ErrorStack instance associated with this BDSException instance.
      java.lang.String getLocalizedMessage() 
      java.lang.String getLocalizedMessage(java.util.Locale locale)
      Returns message string localized for the specified Locale.
      static void setLogDetail(int logDetail)
      Sets static log detail level for the BDSException class.
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • BDSException

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

        public BDSException(ErrorCode errorCode,
                    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

        public BDSException(ErrorCode errorCode,
                    java.lang.Object arg0,
                    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

        public BDSException(ErrorCode errorCode,
                    java.lang.Object arg0,
                    java.lang.Object arg1,
                    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

        public BDSException(ErrorCode errorCode,
                    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

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

        public BDSException(ErrorCode errorCode,
                    java.lang.Throwable cause,
                    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

        public BDSException(ErrorCode errorCode,
                    java.lang.Throwable cause,
                    java.lang.Object arg0,
                    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

        public BDSException(ErrorCode errorCode,
                    java.lang.Throwable cause,
                    java.lang.Object arg0,
                    java.lang.Object arg1,
                    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

        public BDSException(ErrorCode errorCode,
                    java.lang.Throwable cause,
                    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

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

        public BDSException(ErrorCode errorCode,
                    java.lang.Throwable cause,
                    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

        public BDSException(ErrorCode errorCode,
                    ErrorStack errorStack,
                    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

        public BDSException(ErrorCode errorCode,
                    java.lang.Throwable cause,
                    ErrorStack errorStack,
                    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

        public BDSException(ErrorCode errorCode,
                    ErrorStack errorStack,
                    java.lang.Object arg0,
                    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

        public BDSException(ErrorCode errorCode,
                    java.lang.Throwable cause,
                    ErrorStack errorStack,
                    java.lang.Object arg0,
                    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

        public BDSException(ErrorCode errorCode,
                    ErrorStack errorStack,
                    java.lang.Object arg0,
                    java.lang.Object arg1,
                    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

        public BDSException(ErrorCode errorCode,
                    ErrorStack errorStack,
                    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

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

        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

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

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

        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

        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

        public java.lang.StringBuffer dumpBDSException(int logDetail,
                                              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.

© Copyright IBM Corp. 2006, 2013. All Rights Reserved.