ClientDownloadExceptionCode

java.lang.Object
- com.filenet.download.api.exception.ClientDownloadExceptionCode

```
public class ClientDownloadExceptionCode
extends java.lang.Object
```
Enumerates unchecked client download api exception messages.

See Also:

ClientDownloadRuntimeException

Field Summary

Fields
Modifier and Type	Field and Description
`static ClientDownloadExceptionCode`	`CLIENT_DOWNLOAD_API_FEATURE_DOTNET_KEY_FILE_NOT_FOUND` The directory specified in the ServerVersion.isCompatibleWithServer does not contain the key file required for version comparison.
`static ClientDownloadExceptionCode`	`CLIENT_DOWNLOAD_API_FEATURE_KEY_FILE_NOT_FOUND` The directory specified in the ServerVersion.isCompatibleWithServer does not contain the key file required for version comparison.
`static ClientDownloadExceptionCode`	`CLIENT_DOWNLOAD_API_FEATURE_XML_PARSE_EXCEPTION` An XMLStreamException was encountered while attempting to parse feature XML provided by the server.
`static ClientDownloadExceptionCode`	`CLIENT_DOWNLOAD_API_MANIFEST_FILE_WRITE_ERROR` An exception was thrown while writing the Feature manifest file to the download directory.
`static ClientDownloadExceptionCode`	`CLIENT_DOWNLOAD_API_MISSING_COMPONENT_ERROR` An exception was thrown while downloading a Feature component file from the server.
`static ClientDownloadExceptionCode`	`CLIENT_DOWNLOAD_API_PACKAGE_XML_PARSE_EXCEPTION` An XMLStreamException was encountered while attempting to parse package XML provided by the server.
`static ClientDownloadExceptionCode`	`CLIENT_DOWNLOAD_API_SPECIFIED_FEATURE_NOT_FOUND` A feature was specified in the API call that could not be found on the server.
`static ClientDownloadExceptionCode`	`CLIENT_DOWNLOAD_API_SPECIFIED_PACKAGE_NOT_FOUND` A package was specified in the API call that could not be found on the server.
`static ClientDownloadExceptionCode`	`CLIENT_DOWNLOAD_API_VERSION_XML_PARSE_EXCEPTION` An XMLStreamException was encountered while attempting to parse version XML provided by the server.
`static java.util.Locale`	`stDefaultLocale`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ClientDownloadExceptionCode`	`getClientDownloadExceptionCode(java.lang.String key)` Gets the ClientDownloadExceptionCode object identified by the specified resource key.
`java.lang.String`	`getDefaultEnglishString()` Returns default English pattern string.
`java.lang.String`	`getId()` Returns id.
`java.lang.String`	`getKey()` Returns resource key.
`java.lang.String`	`toString(java.util.Locale le, java.lang.Object[] args)` Returns a `String` representation of the exception using the specified locale.
`java.lang.String`	`toString(java.lang.Object[] args)` Returns a `String` representation of the exception (using the default locale).

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - stDefaultLocale
```
public static final java.util.Locale stDefaultLocale
```
  - CLIENT_DOWNLOAD_API_FEATURE_XML_PARSE_EXCEPTION
```
public static final ClientDownloadExceptionCode CLIENT_DOWNLOAD_API_FEATURE_XML_PARSE_EXCEPTION
```
    An XMLStreamException was encountered while attempting to parse feature XML provided by the server.
  - CLIENT_DOWNLOAD_API_PACKAGE_XML_PARSE_EXCEPTION
```
public static final ClientDownloadExceptionCode CLIENT_DOWNLOAD_API_PACKAGE_XML_PARSE_EXCEPTION
```
    An XMLStreamException was encountered while attempting to parse package XML provided by the server.
  - CLIENT_DOWNLOAD_API_VERSION_XML_PARSE_EXCEPTION
```
public static final ClientDownloadExceptionCode CLIENT_DOWNLOAD_API_VERSION_XML_PARSE_EXCEPTION
```
    An XMLStreamException was encountered while attempting to parse version XML provided by the server.
  - CLIENT_DOWNLOAD_API_SPECIFIED_PACKAGE_NOT_FOUND
```
public static final ClientDownloadExceptionCode CLIENT_DOWNLOAD_API_SPECIFIED_PACKAGE_NOT_FOUND
```
    A package was specified in the API call that could not be found on the server. See the reference documentation for the Package class, which states the package ID string to pass in a call.
  - CLIENT_DOWNLOAD_API_SPECIFIED_FEATURE_NOT_FOUND
```
public static final ClientDownloadExceptionCode CLIENT_DOWNLOAD_API_SPECIFIED_FEATURE_NOT_FOUND
```
    A feature was specified in the API call that could not be found on the server. See the reference documentation for the Feature class, which states the feature ID string to pass in a call.
  - CLIENT_DOWNLOAD_API_FEATURE_KEY_FILE_NOT_FOUND
```
public static final ClientDownloadExceptionCode CLIENT_DOWNLOAD_API_FEATURE_KEY_FILE_NOT_FOUND
```
    The directory specified in the ServerVersion.isCompatibleWithServer does not contain the key file required for version comparison. For more information about key files, see the ServerVersion.isCompatibleWithServer method in the reference documentation.
  - CLIENT_DOWNLOAD_API_MANIFEST_FILE_WRITE_ERROR
```
public static final ClientDownloadExceptionCode CLIENT_DOWNLOAD_API_MANIFEST_FILE_WRITE_ERROR
```
    An exception was thrown while writing the Feature manifest file to the download directory. Verify that you have the required disk space or write permission to download components.
  - CLIENT_DOWNLOAD_API_MISSING_COMPONENT_ERROR
```
public static final ClientDownloadExceptionCode CLIENT_DOWNLOAD_API_MISSING_COMPONENT_ERROR
```
    An exception was thrown while downloading a Feature component file from the server. Verify that the missing componet exists in the Download directory of the Client Download Servlet.
  - CLIENT_DOWNLOAD_API_FEATURE_DOTNET_KEY_FILE_NOT_FOUND
```
public static final ClientDownloadExceptionCode CLIENT_DOWNLOAD_API_FEATURE_DOTNET_KEY_FILE_NOT_FOUND
```
    The directory specified in the ServerVersion.isCompatibleWithServer does not contain the key file required for version comparison. The key file has either been deleted from the direcory or the .NET client file being compared is a version prior to CPE 5.2.1 when this feature was implemented and so cannot be compared.
- Method Detail
  - getKey
```
public java.lang.String getKey()
```
    Returns resource key.
  - getId
```
public java.lang.String getId()
```
    Returns id.
  - getDefaultEnglishString
```
public java.lang.String getDefaultEnglishString()
```
    Returns default English pattern string.
  - toString
```
public java.lang.String toString(java.lang.Object[] args)
```
    Returns a String representation of the exception (using the default locale). This method is thread safe.
    
    Parameters:
    
    args - An Object array containing the exception message values (code arguments in use when the exception occurred).
    
    Returns:
    
    A String representation of the exception message, based on the default locale.
  - toString
```
public java.lang.String toString(java.util.Locale le,
                                 java.lang.Object[] args)
```
    Returns a String representation of the exception using the specified locale. This method is thread safe.
    
    Parameters:
    
    le - A Locale object specifying the locale to use for the exception.
    
    args - An Object array containing the exception message values (code arguments in use when the exception occurred).
    
    Returns:
    
    A String representation of the exception message, based on the specified locale.
  - getClientDownloadExceptionCode
```
public static ClientDownloadExceptionCode getClientDownloadExceptionCode(java.lang.String key)
```
    Gets the ClientDownloadExceptionCode object identified by the specified resource key. The resource key is an ClientDownloadExceptionCode field name. This method is thread safe.

Methods inherited from class java.lang.Object

stDefaultLocale

CLIENT_DOWNLOAD_API_FEATURE_XML_PARSE_EXCEPTION

CLIENT_DOWNLOAD_API_PACKAGE_XML_PARSE_EXCEPTION

CLIENT_DOWNLOAD_API_VERSION_XML_PARSE_EXCEPTION

CLIENT_DOWNLOAD_API_SPECIFIED_PACKAGE_NOT_FOUND

CLIENT_DOWNLOAD_API_SPECIFIED_FEATURE_NOT_FOUND

CLIENT_DOWNLOAD_API_FEATURE_KEY_FILE_NOT_FOUND

CLIENT_DOWNLOAD_API_MANIFEST_FILE_WRITE_ERROR

CLIENT_DOWNLOAD_API_MISSING_COMPONENT_ERROR

CLIENT_DOWNLOAD_API_FEATURE_DOTNET_KEY_FILE_NOT_FOUND

getKey

getId

getDefaultEnglishString

toString

toString

getClientDownloadExceptionCode