com.crystaldecisions.sdk.exception
Class SDKException

java.lang.Object
  |
  +--AbstractException
        |
        +--com.crystaldecisions.sdk.exception.SDKException

Direct Known Subclasses:

SDKBatchException, SDKException.ConfigurationError, SDKException.ContradictingValues, SDKException.CORBASystem, SDKException.CORBAUser, SDKException.DifferentDeployment, SDKException.DifferentEnterpriseVersion, SDKException.EndOfFile, SDKException.FileRead, SDKException.FileWrite, SDKException.InvalidArg, SDKException.InvalidCMSSyntax, SDKException.InvalidCopyMode, SDKException.InvalidObjectID, SDKException.InvalidOperation, SDKException.InvalidPagingIndex, SDKException.InvalidRightKind, SDKException.NativeError, SDKException.NoRight, SDKException.NoRightChildren, SDKException.NotImplemented, SDKException.ObjectNotFound, SDKException.OCAFramework, SDKException.OutOfRange, SDKException.PageServerError, SDKException.PluginCategory, SDKException.PluginInitialization, SDKException.PluginNotFound, SDKException.PluginNotFoundAtCMS, SDKException.PropertyNotFound, SDKException.PropertyReadOnly, SDKException.SameDeployment, SDKException.SecurityError, SDKException.ServiceFailure, SDKException.ServiceNotFound, SDKException.StreamRead, SDKException.TimeOut, SDKException.Unexpected, SDKException.UnexpectedValue, SDKException.UnsupportedEnterpriseVersion, SDKException.URIFormat, SDKServerException

public class SDKException

extends AbstractException

All exceptions within the SDK are mapped to SDKException. The exception policy is this: Exceptions are caught at the earliest opportunity, mapped to an SDKException and optionally re-thrown. SDK methods should throw only SDKException and nothing else.

See Also:

Serialized Form

Nested Class Summary

static class	SDKException.ConfigurationError This exception is thrown when an error occurs due to an invalid system property value.
static class	SDKException.ContradictingValues This exception denotes two properties have contradicting values
static class	SDKException.CORBASystem This exception wraps a CORBA system exception generated by the transport layer.
static class	SDKException.CORBAUser This exception wraps a CORBA user exception generated by the underlying transport.
static class	SDKException.DifferentDeployment This exception is thrown when an operation does not support source and target InfoObjects from different deployments, or clusters.
static class	SDKException.DifferentEnterpriseVersion This exception is thrown when an operation doesn't support InfoObjects collections from different versions of BusinessObjects Enterprise.
static class	SDKException.EndOfFile This exception denotes the end of a file has been reached while trying to read from the file.
static class	SDKException.FileRead This exception is thrown when a file could not be read from the FRS.
static class	SDKException.FileWrite This exception is thrown when a file could not be written to the FRS.
static class	SDKException.InvalidArg This exception is thrown when an invalid argument is given to a method.
static class	SDKException.InvalidCMSSyntax This exception denotes the syntax of the CMS name is invalid.
static class	SDKException.InvalidCopyMode This exception is thrown when an invalid copy mode is specified when copying an InfoObject.
static class	SDKException.InvalidObjectID This exception is thrown when the object with a particular ID (SI_ID or SI_CUID) cannot be found on the CMS.
static class	SDKException.InvalidOperation This exception is thrown when trying to perform an invalid or unsupported operation.
static class	SDKException.InvalidPagingIndex This exception is thrown when a failure to get valid page indices information occurs; as a result paging cannot continue.
static class	SDKException.InvalidRightKind This exception is thrown when an invalid right kind is found.
static class	SDKException.NativeError This exception is thrown when a native method call fails.
static class	SDKException.NoRight This exception is thrown when the logged on user does not have sufficient rights to perform the requested operation.
static class	SDKException.NoRightChildren This exception is thrown when the logged on user does not have sufficient rights to perform the requested operation on some of the children objects of a given object.
static class	SDKException.NotImplemented This exception is thrown when there is an indication that an SDK method is not implemented.
static class	SDKException.ObjectNotFound This exception is thrown when the target object cannot be found in the InfoObjects collection.
static class	SDKException.OCAFramework This exception wraps around a OCAFrameworkException.
static class	SDKException.OutOfRange This exception is thrown when an input value is out of the expected range
static class	SDKException.PageServerError This exception is thrown by the PageServerRequester when an error occurs.
static class	SDKException.PluginCategory This exception is thrown when an invalid plugin category is specified.
static class	SDKException.PluginInitialization This exception is thrown when there is a problem initializing a plugin.
static class	SDKException.PluginNotFound This exception is thrown when the plugin manager cannot find a Java version of the plugin.
static class	SDKException.PluginNotFoundAtCMS This exception is thrown when the plugin type is unknown at the CMS.
static class	SDKException.PropertyNotFound This exception is thrown when a property is not found in the IInfoObject.
static class	SDKException.PropertyReadOnly This exception is thrown when an attempt is made to modify a read only property.
static class	SDKException.SameDeployment This exception is thrown when an operation does not support source and target InfoObjects from the same deployment, or cluster.
static class	SDKException.SecurityError This exception is thrown by the authentication plugins when an error occurs.
static class	SDKException.Serialization This is a wrapper for SDKExceptions thrown during serialization.
static class	SDKException.ServiceFailure This exception is thrown when a service cannot be obtained from a server.
static class	SDKException.ServiceNotFound This exception is thrown when an unknown service name is used.
static class	SDKException.StreamRead This exception is thrown when a stream could not be read from the FRS.
static class	SDKException.TimeOut This exception is thrown when an operation times out.
static class	SDKException.Unexpected This exception is a catch-all for any problems that may occur which are not expected to occur under normal conditions.
static class	SDKException.UnexpectedValue This exception is thrown when an IInfoObject property contains an unexpected value.
static class	SDKException.UnsupportedEnterpriseVersion This exception is thrown when a connection is made to an unsupported BusinessObjects Enterprise system.
static class	SDKException.URIFormat This exception is thrown when a URI is not of the proper format.

Method Summary

java.lang.Throwable	getCause() Returns the exception that caused this one to be thrown.
java.lang.String	getDetail() Returns the detail of the exception that caused this one to be thrown.
java.lang.String	getMessage() Returns the message of the exception that caused this one to be thrown.
java.lang.String	getMessage(java.util.Locale locale) Returns the message of the exception that caused this one to be thrown based on the Locale.
static SDKException	map(com.crystaldecisions.thirdparty.org.omg.CORBA.SystemException ex) Map CORBA System exceptions.
java.lang.String	toString() Returns the String of the exception that caused this one to be thrown.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getCause

public java.lang.Throwable getCause()

Returns the exception that caused this one to be thrown.

getDetail

public java.lang.String getDetail()

Returns the detail of the exception that caused this one to be thrown.

getMessage

public java.lang.String getMessage()

Returns the message of the exception that caused this one to be thrown.

getMessage

public java.lang.String getMessage(java.util.Locale locale)

Returns the message of the exception that caused this one to be thrown based on the Locale.

toString

public java.lang.String toString()

Returns the String of the exception that caused this one to be thrown.

map

public static SDKException map(com.crystaldecisions.thirdparty.org.omg.CORBA.SystemException ex)

Map CORBA System exceptions.