com.crystaldecisions.sdk.occa.report.lib
Class ReportSDKClientDocException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.crystaldecisions.sdk.occa.report.lib.ReportSDKExceptionBase
              extended by com.crystaldecisions.sdk.occa.report.lib.ReportSDKException
                  extended by com.crystaldecisions.sdk.occa.report.lib.ReportSDKClientDocException
All Implemented Interfaces:
java.io.Serializable

public class ReportSDKClientDocException
extends ReportSDKException

This class defines an exception thrown due to report client document errors.

See Also:
Serialized Form

Constructor Summary
ReportSDKClientDocException(int errorCode, java.lang.String errorMsg)
          Deprecated. As of version 4.0. Replaced by ReportSDKClientDocException.ReportSDKClientDocException(String, int, String).
ReportSDKClientDocException(int errorCode, java.lang.String errorMsg, java.lang.Throwable previous)
          Deprecated. As of version 4.0. Replaced by ReportSDKClientDocException.ReportSDKClientDocException(String, int, String, Throwable).
ReportSDKClientDocException(java.lang.String RCI, int errorCode, java.lang.String errorMsg)
          For internal use only.
ReportSDKClientDocException(java.lang.String RCI, int errorCode, java.lang.String errorMsg, java.lang.Throwable previous)
          For internal use only.
 
Method Summary
 ReportSDKClientDocError getClientDocError()
          Gets the SDK error code, which is indicative of the cause of the exception.
static void throwReportSDKClientDocException(int errorCode, java.lang.String msg)
          Deprecated. As of version 4.0. Replaced by ReportSDKClientDocException.throwReportSDKClientDocException(String, int, String).
static void throwReportSDKClientDocException(int errorCode, java.lang.String msg, java.lang.Throwable previous)
          Deprecated. As of version 4.0. Replaced by ReportSDKClientDocException.throwReportSDKClientDocException(String, int, String, Throwable).
static void throwReportSDKClientDocException(java.lang.String RCI, int errorCode, java.lang.String msg)
          For internal use only.
static void throwReportSDKClientDocException(java.lang.String RCI, int errorCode, java.lang.String msg, java.lang.Throwable previous)
          For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ReportSDKException
getSDKError, throwReportSDKException, throwReportSDKException, throwReportSDKException, throwReportSDKException, throwReportSDKException, toString
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ReportSDKExceptionBase
errorCode, findCause, getRootCauseIdentifier, isCausedByA
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReportSDKClientDocException

@Deprecated
public ReportSDKClientDocException(int errorCode,
                                              java.lang.String errorMsg)
Deprecated. As of version 4.0. Replaced by ReportSDKClientDocException.ReportSDKClientDocException(String, int, String).


ReportSDKClientDocException

@Deprecated
public ReportSDKClientDocException(int errorCode,
                                              java.lang.String errorMsg,
                                              java.lang.Throwable previous)
Deprecated. As of version 4.0. Replaced by ReportSDKClientDocException.ReportSDKClientDocException(String, int, String, Throwable).


ReportSDKClientDocException

public ReportSDKClientDocException(java.lang.String RCI,
                                   int errorCode,
                                   java.lang.String errorMsg)
For internal use only.


ReportSDKClientDocException

public ReportSDKClientDocException(java.lang.String RCI,
                                   int errorCode,
                                   java.lang.String errorMsg,
                                   java.lang.Throwable previous)
For internal use only.

Method Detail

getClientDocError

public ReportSDKClientDocError getClientDocError()
Gets the SDK error code, which is indicative of the cause of the exception.

Returns:
a ReportSDKClientDocError indicative of the cause of the exception
See Also:
ReportSDKClientDocError

throwReportSDKClientDocException

@Deprecated
public static void throwReportSDKClientDocException(int errorCode,
                                                               java.lang.String msg)
                                             throws ReportSDKClientDocException
Deprecated. As of version 4.0. Replaced by ReportSDKClientDocException.throwReportSDKClientDocException(String, int, String).

Throws:
ReportSDKClientDocException

throwReportSDKClientDocException

@Deprecated
public static void throwReportSDKClientDocException(int errorCode,
                                                               java.lang.String msg,
                                                               java.lang.Throwable previous)
                                             throws ReportSDKClientDocException
Deprecated. As of version 4.0. Replaced by ReportSDKClientDocException.throwReportSDKClientDocException(String, int, String, Throwable).

Throws:
ReportSDKClientDocException

throwReportSDKClientDocException

public static void throwReportSDKClientDocException(java.lang.String RCI,
                                                    int errorCode,
                                                    java.lang.String msg)
                                             throws ReportSDKClientDocException
For internal use only.

Throws:
ReportSDKClientDocException

throwReportSDKClientDocException

public static void throwReportSDKClientDocException(java.lang.String RCI,
                                                    int errorCode,
                                                    java.lang.String msg,
                                                    java.lang.Throwable previous)
                                             throws ReportSDKClientDocException
For internal use only.

Throws:
ReportSDKClientDocException