Provides an IDK Version class and common exception classes used by multiple services.
| Class | Description |
|---|---|
| AccessDeniedException | Thrown when the user does not have access to the requested resource. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. The resource is not removed from the portal when this exception is thrown. |
| AccountExpiredException | Thrown from Authenticate to tell the portal that the user's account has expired. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| AccountLockedException | Thrown from Authenticate to tell the portal that the user's account has been locked or disabled. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| CustomAuthenticationFailureException | Throw this exception from Authenticate to tell the portal that there was a custom authentication failure. Returned to the portal as a string containing the error message provided instead of as a SOAP Fault. |
| CustomServiceFailureException | Thrown from Authenticate to tell the portal that there was a custom service failure. Returned to the portal as a string containing the error message provided instead of as a SOAP Fault. |
| GeneralFailureException | Thrown from Authenticate to tell the portal that there was a general failure when attempting to authenticate the user. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| InvalidConfigurationException | Thrown from Authenticate to tell the portal that the remote server configuration is invalid. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| InvalidUsernameOrPasswordException | Thrown from Authenticate to tell the portal that the user has entered an invalid username or password. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| NoLongerExistsException | Thrown from a Crawler Web Service implementation of AttachToContainer or AttachToDocument when the requested resource no longer exists. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. Note: The resource is removed from the portal when this exception is thrown. |
| NoSuchUserException | Thrown when the requested user does not exist. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| NotAvailableException | Thrown when the referenced object is no longer available. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. The resource is not removed from the portal when this exception is thrown. |
| NotInitializedException | Thrown when the referenced object has not been initialized. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| PasswordExpiredException | Thrown from Authenticate to tell the portal that the user's password has expired and must be changed. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| PasswordMustChangeException | Thrown from Authenticate to tell the portal that the user's password must be changed. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| RemoteServerUnavailableException | Thrown from Authenticate to tell the portal that the remote server is unavailable. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| RemoteServerUnreachableException | Thrown from Authenticate to tell the portal that the remote server is unreachable. Returned to the portal as a string containing a status code (and error message if provided) instead of as a SOAP Fault. |
| ServiceException | Base class for exceptions. ServiceExceptions are returned to the portal as SOAP Faults, except in the cases of subclasses that return a status code. These subclasses include: AccessDeniedException, AccountExpiredException, AccountLockedException, CustomAuthenticationFailureException,
CustomServiceFailureException, GeneralFailureException, InvalidConfigurationException,
InvalidUsernameOrPasswordException, NoLongerExistsException, NoSuchUserException,
NotAvailableException, NotInitializedException, PasswordExpiredException,
PasswordMustChangeException, RemoteServerUnavailableException, RemoteServerUnreachableException,
ValidationException, and SearchException. |
| Version | Provides information about the IDK build version, such as the major and minor version numbers of the build. The printable string includes additional information, such as the source changelist number and the date of the build. |