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

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
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ReportDefControllerException, ReportSDKClientDocException, ReportSDKFormulaFieldException, ReportSDKGroupException, ReportSDKInvalidDBDriverException, ReportSDKInvalidSecurityRightsException, ReportSDKParameterFieldException, ReportSDKPrinterException, ReportSDKResultFieldException, ReportSDKServerException, ReportSDKSortException, ReportSDKSummaryFieldException, ReportTemplateException

public class ReportSDKException
extends ReportSDKExceptionBase

All exceptions within the Report SDK are mapped to ReportSDKException. The exception policy is this: Exceptions are caught at the earliest opportunity, mapped to a ReportSDKException and optionally re-thrown. Report SDK methods declare to throw only ReportSDKExceptions.

See Also:
Serialized Form

Constructor Summary
ReportSDKException(int errorCode, java.lang.String errorMsg)
          Deprecated. As of version 4.0. Replaced by ReportSDKException.ReportSDKException(String, int, String).
ReportSDKException(int errorCode, java.lang.String errorMsg, java.lang.Throwable cause)
          Deprecated. As of version 4.0. Replaced by ReportSDKException.ReportSDKException(String, int, String, Throwable).
ReportSDKException(java.lang.String RCI, int errorCode, java.lang.String errorMsg)
          For internal use only.
ReportSDKException(java.lang.String RCI, int errorCode, java.lang.String errorMsg, java.lang.Throwable cause)
          For internal use only.
 
Method Summary
 ReportSDKError getSDKError()
          Gets the SDK error code, which is indicative of the cause of the exception.
static void throwReportSDKException(int errorCode, java.lang.String msg)
          Deprecated. As of version 4.0. Replaced by ReportSDKException.throwReportSDKException(String, int, String).
static void throwReportSDKException(int errorCode, java.lang.String msg, java.lang.Throwable previous)
          Deprecated. As of version 4.0. Replaced by ReportSDKException.throwReportSDKException(String, int, String, Throwable).
static void throwReportSDKException(java.lang.String RCI, int errorCode, java.lang.String msg)
          For internal use only.
static void throwReportSDKException(java.lang.String RCI, int errorCode, java.lang.String msg, java.lang.Throwable previous)
          For internal use only.
static void throwReportSDKException(java.lang.String msg, ReportSDKException original)
          For internal use only.
 java.lang.String toString()
          Returns a short description of this exception, including the name of the ReportSDKError code.
 
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

ReportSDKException

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

For internal use only.


ReportSDKException

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

For internal use only.


ReportSDKException

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


ReportSDKException

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

Method Detail

getSDKError

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

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

throwReportSDKException

public static void throwReportSDKException(java.lang.String msg,
                                           ReportSDKException original)
                                    throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

throwReportSDKException

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

For internal use only.

Throws:
ReportSDKException

throwReportSDKException

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

For internal use only.

Throws:
ReportSDKException

throwReportSDKException

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

Throws:
ReportSDKException

throwReportSDKException

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

Throws:
ReportSDKException

toString

public java.lang.String toString()
Returns a short description of this exception, including the name of the ReportSDKError code.

Overrides:
toString in class ReportSDKExceptionBase
Returns:
a String representation of this exception