com.ibm.as400.access
Class LicenseException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.as400.access.LicenseException
All Implemented Interfaces:
ReturnCodeException, Serializable

public class LicenseException
extends Exception
implements ReturnCodeException

Indicates an error condition that occured while trying to retrieve a license.

See Also:
Serialized Form

Field Summary
static int DATA_CONVERSION_CLIENT_NAME
          DATA_CONVERSION_CLIENT_NAME - Return code from the Central server when the client name can not be converted to the job CCSID.
static int DATA_CONVERSION_FEATURE
          DATA_CONVERSION_FEATURE - Return code from the Central server when the product feature can not be converted to the job CCSID.
static int DATA_CONVERSION_LICENSE_USER_HANDLE
          DATA_CONVERSION_LICENSE_USER_HANDLE - Return code from the Central server when the license handle is not valid.
static int DATA_CONVERSION_PRODUCT_ID
          DATA_CONVERSION_PRODUCT_ID - Return code from the Central server when the product ID can not be converted to the job CCSID.
static int DATA_CONVERSION_RELEASE
          DATA_CONVERSION_RELEASE - Return code from the Central server when the product release can not be converted to the job CCSID.
static int ERROR_CALLING_EXIT_PROGRAM
          ERROR_CALLING_EXIT_PROGRAM - Return code from the Central server when there was an error calling the regestered exit program.
static int ERROR_CALLING_USER_EXIT_PROGRAM
          ERROR_CALLING_USER_EXIT_PROGRAM - Return code from the Central server when in incurred an error from a user exit program.
static int EXPIRATION_DATE_REACHED
          EXPIRATION_DATE_REACHED - Return code from the Central server when the expiration date for the product license being requested is reached and a license was not granted.
static int GRACE_PERIOD_EXPIRED
          GRACE_PERIOD_EXPIRED - Return code from the Central server when the grace period for the product license being requested is exceeded and a license was not granted.
static int INVALID_REQUEST_CLIENT_NAME
          INVALID_REQUEST_CLIENT_NAME - Return code from the Central server when the client name is not valid.
static int LICENSE_INFORMATION_NOT_AVAILABLE
          LICENSE_INFORMATION_NOT_AVAILABLE - Return code from the Central server when an error occurred.
static int LICENSE_INFORMATION_NOT_FOUND
          LICENSE_INFORMATION_NOT_FOUND - Return code from the Central server when the license information for the product is not available (for example, product for specified feature and release was not found.)
static int MISMATCH_RELEASE_REQUEST_HANDLE
          MISMATCH_RELEASE_REQUEST_HANDLE - Return code from the Central server when the handle used to attempt to release a license is not the handle that the under which the request license was issued.
static int REJECTED_BY_EXIT_PROGRAM
          REJECTED_BY_EXIT_PROGRAM - Return code from the Central server when the regestered exit program rejects the request.
static int RELEASE_LICENSE_ERROR
          RELEASE_LICENSE_ERROR - Return code from the Central server when an unexpected error is encountered when releasing a license.
static int REQUEST_LICENSE_ERROR
          REQUEST_LICENSE_ERROR - Return code from the Central server when an unexpected error is encountered when requesting a license.
static int REQUEST_NOT_VALID
          REQUEST_NOT_VALID - Return code from the Central server when the datastream does not match the expected datastream.
static int REQUEST_NOT_VALID_FEATURE
          REQUEST_NOT_VALID_FEATURE - Return code from the Central server when the product feature ID is not valid.
static int REQUEST_NOT_VALID_LICENSE_USER_HANDLE
          REQUEST_NOT_VALID_LICENSE_USER_HANDLE - Return code from the Central server when the license user handle is not valid.
static int REQUEST_NOT_VALID_PRODUCT_ID
          REQUEST_NOT_VALID_PRODUCT_ID - Return code from the Central server when the product ID is not valid.
static int REQUEST_NOT_VALID_RELEASE
          REQUEST_NOT_VALID_RELEASE - Return code from the Central server when the product release is not valid.
static int REQUEST_NOT_VALID_TYPE_OF_LICENSE_INFO
          REQUEST_NOT_VALID_TYPE_OF_LICENSE_INFO - Return code from the Central server when the type of license information requested is not valid.
static int RETRIEVE_LICENSE_INFORMATION_ERROR
          RETRIEVE_LICENSE_INFORMATION_ERROR - Return code from the Central server when an unexpected error is encountered when requesting information on a license.
static int USAGE_LIMIT_EXCEEDED
          USAGE_LIMIT_EXCEEDED - Return code from the Central server when the usage limit for the product license being requested is exceeded and a license was not granted.
 
Method Summary
 int getReturnCode()
          Returns the return code.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INVALID_REQUEST_CLIENT_NAME

public static final int INVALID_REQUEST_CLIENT_NAME

INVALID_REQUEST_CLIENT_NAME - Return code from the Central server when the client name is not valid.

See Also:
Constant Field Values

REQUEST_NOT_VALID_LICENSE_USER_HANDLE

public static final int REQUEST_NOT_VALID_LICENSE_USER_HANDLE

REQUEST_NOT_VALID_LICENSE_USER_HANDLE - Return code from the Central server when the license user handle is not valid.

See Also:
Constant Field Values

REQUEST_NOT_VALID_PRODUCT_ID

public static final int REQUEST_NOT_VALID_PRODUCT_ID

REQUEST_NOT_VALID_PRODUCT_ID - Return code from the Central server when the product ID is not valid.

See Also:
Constant Field Values

REQUEST_NOT_VALID_RELEASE

public static final int REQUEST_NOT_VALID_RELEASE

REQUEST_NOT_VALID_RELEASE - Return code from the Central server when the product release is not valid.

See Also:
Constant Field Values

REQUEST_NOT_VALID_FEATURE

public static final int REQUEST_NOT_VALID_FEATURE

REQUEST_NOT_VALID_FEATURE - Return code from the Central server when the product feature ID is not valid.

See Also:
Constant Field Values

REQUEST_NOT_VALID_TYPE_OF_LICENSE_INFO

public static final int REQUEST_NOT_VALID_TYPE_OF_LICENSE_INFO

REQUEST_NOT_VALID_TYPE_OF_LICENSE_INFO - Return code from the Central server when the type of license information requested is not valid.

See Also:
Constant Field Values

DATA_CONVERSION_CLIENT_NAME

public static final int DATA_CONVERSION_CLIENT_NAME

DATA_CONVERSION_CLIENT_NAME - Return code from the Central server when the client name can not be converted to the job CCSID.

See Also:
Constant Field Values

DATA_CONVERSION_LICENSE_USER_HANDLE

public static final int DATA_CONVERSION_LICENSE_USER_HANDLE

DATA_CONVERSION_LICENSE_USER_HANDLE - Return code from the Central server when the license handle is not valid.

See Also:
Constant Field Values

DATA_CONVERSION_PRODUCT_ID

public static final int DATA_CONVERSION_PRODUCT_ID

DATA_CONVERSION_PRODUCT_ID - Return code from the Central server when the product ID can not be converted to the job CCSID.

See Also:
Constant Field Values

DATA_CONVERSION_RELEASE

public static final int DATA_CONVERSION_RELEASE

DATA_CONVERSION_RELEASE - Return code from the Central server when the product release can not be converted to the job CCSID.

See Also:
Constant Field Values

DATA_CONVERSION_FEATURE

public static final int DATA_CONVERSION_FEATURE

DATA_CONVERSION_FEATURE - Return code from the Central server when the product feature can not be converted to the job CCSID.

See Also:
Constant Field Values

REQUEST_NOT_VALID

public static final int REQUEST_NOT_VALID

REQUEST_NOT_VALID - Return code from the Central server when the datastream does not match the expected datastream.

See Also:
Constant Field Values

ERROR_CALLING_EXIT_PROGRAM

public static final int ERROR_CALLING_EXIT_PROGRAM

ERROR_CALLING_EXIT_PROGRAM - Return code from the Central server when there was an error calling the regestered exit program. For example, does not exist.

See Also:
Constant Field Values

REJECTED_BY_EXIT_PROGRAM

public static final int REJECTED_BY_EXIT_PROGRAM

REJECTED_BY_EXIT_PROGRAM - Return code from the Central server when the regestered exit program rejects the request.

See Also:
Constant Field Values

REQUEST_LICENSE_ERROR

public static final int REQUEST_LICENSE_ERROR

REQUEST_LICENSE_ERROR - Return code from the Central server when an unexpected error is encountered when requesting a license.

See Also:
Constant Field Values

RELEASE_LICENSE_ERROR

public static final int RELEASE_LICENSE_ERROR

RELEASE_LICENSE_ERROR - Return code from the Central server when an unexpected error is encountered when releasing a license.

See Also:
Constant Field Values

RETRIEVE_LICENSE_INFORMATION_ERROR

public static final int RETRIEVE_LICENSE_INFORMATION_ERROR

RETRIEVE_LICENSE_INFORMATION_ERROR - Return code from the Central server when an unexpected error is encountered when requesting information on a license.

See Also:
Constant Field Values

LICENSE_INFORMATION_NOT_FOUND

public static final int LICENSE_INFORMATION_NOT_FOUND

LICENSE_INFORMATION_NOT_FOUND - Return code from the Central server when the license information for the product is not available (for example, product for specified feature and release was not found.)

See Also:
Constant Field Values

LICENSE_INFORMATION_NOT_AVAILABLE

public static final int LICENSE_INFORMATION_NOT_AVAILABLE

LICENSE_INFORMATION_NOT_AVAILABLE - Return code from the Central server when an error occurred.

See Also:
Constant Field Values

MISMATCH_RELEASE_REQUEST_HANDLE

public static final int MISMATCH_RELEASE_REQUEST_HANDLE

MISMATCH_RELEASE_REQUEST_HANDLE - Return code from the Central server when the handle used to attempt to release a license is not the handle that the under which the request license was issued.

See Also:
Constant Field Values

USAGE_LIMIT_EXCEEDED

public static final int USAGE_LIMIT_EXCEEDED

USAGE_LIMIT_EXCEEDED - Return code from the Central server when the usage limit for the product license being requested is exceeded and a license was not granted.

See Also:
Constant Field Values

GRACE_PERIOD_EXPIRED

public static final int GRACE_PERIOD_EXPIRED

GRACE_PERIOD_EXPIRED - Return code from the Central server when the grace period for the product license being requested is exceeded and a license was not granted.

See Also:
Constant Field Values

EXPIRATION_DATE_REACHED

public static final int EXPIRATION_DATE_REACHED

EXPIRATION_DATE_REACHED - Return code from the Central server when the expiration date for the product license being requested is reached and a license was not granted.

See Also:
Constant Field Values

ERROR_CALLING_USER_EXIT_PROGRAM

public static final int ERROR_CALLING_USER_EXIT_PROGRAM

ERROR_CALLING_USER_EXIT_PROGRAM - Return code from the Central server when in incurred an error from a user exit program.

See Also:
Constant Field Values
Method Detail

getReturnCode

public int getReturnCode()
Returns the return code.

Specified by:
getReturnCode in interface ReturnCodeException
Returns:
The return code associated with this exception.