com.ibm.as400.access
Class ExtendedIllegalStateException

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

public class ExtendedIllegalStateException
extends IllegalStateException
implements ReturnCodeException

The ExtendedIllegalStateException class represents an exception that indicates that an object is not in the proper state to perform the requested operation.

See Also:
Serialized Form

Field Summary
static int COMMITMENT_CONTROL_ALREADY_STARTED
          The return code indicating that the commitment control has already been started.
static int IMPLEMENTATION_NOT_FOUND
          The return code indicating that an IBM Toolbox for Java implementation class was not found.
static int INFORMATION_NOT_AVAILABLE
          The return code indicating that the requested information is not available.
static int LICENSE_CAN_NOT_BE_REQUESTED
          The return code indicating that the license can not be requested.
static int OBJECT_CAN_NOT_BE_OPEN
          The return code indicating that a request was made that requires the object to not be open and the object was in an open state.
static int OBJECT_CAN_NOT_START_THREADS
          The return code indicating that this object is not allowed to start threads.
static int OBJECT_CANNOT_BE_FOUND
          The return code indicating that a request was made to find an object and that object was not found.
static int OBJECT_IS_READ_ONLY
          The return code indicating that a request was made that requires the object to be writable and the object was in a read-only state.
static int OBJECT_MUST_BE_OPEN
          The return code indicating that a request was made that requires the object to be open and the object was not in an open state.
static int PROPERTY_NOT_CHANGED
          The return code indicating that the property cannot be changed.
static int PROPERTY_NOT_SET
          The return code indicating that one or more properties have not been set.
static int PROXY_SERVER_ALREADY_STARTED
          The return code indicating that the proxy server has already been started.
static int PROXY_SERVER_EVENT_NOT_FIRED
          The return code indicating that the proxy server did not fire an event because the listener was not accessible.
static int PROXY_SERVER_NOT_STARTED
          The return code indicating that the proxy server has not been started.
static int SIGNON_ALREADY_IN_PROGRESS
          The return code indicating that a signon is already in progress.
static int UNKNOWN
          The return code indicating that the exact cause of the failure is not known.
 
Constructor Summary
ExtendedIllegalStateException(int returnCode)
          Constructs an ExtendedIllegalStateException object.
ExtendedIllegalStateException(String property, int returnCode)
          Constructs an ExtendedIllegalStateException object.
 
Method Summary
 int getReturnCode()
          Returns the return code associated with this exception.
 
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

COMMITMENT_CONTROL_ALREADY_STARTED

public static final int COMMITMENT_CONTROL_ALREADY_STARTED
The return code indicating that the commitment control has already been started.

See Also:
Constant Field Values

IMPLEMENTATION_NOT_FOUND

public static final int IMPLEMENTATION_NOT_FOUND
The return code indicating that an IBM Toolbox for Java implementation class was not found.

See Also:
Constant Field Values

INFORMATION_NOT_AVAILABLE

public static final int INFORMATION_NOT_AVAILABLE
The return code indicating that the requested information is not available.

See Also:
Constant Field Values

LICENSE_CAN_NOT_BE_REQUESTED

public static final int LICENSE_CAN_NOT_BE_REQUESTED
The return code indicating that the license can not be requested.

See Also:
Constant Field Values

OBJECT_CANNOT_BE_FOUND

public static final int OBJECT_CANNOT_BE_FOUND
The return code indicating that a request was made to find an object and that object was not found.

See Also:
Constant Field Values

OBJECT_CAN_NOT_BE_OPEN

public static final int OBJECT_CAN_NOT_BE_OPEN
The return code indicating that a request was made that requires the object to not be open and the object was in an open state.

See Also:
Constant Field Values

OBJECT_IS_READ_ONLY

public static final int OBJECT_IS_READ_ONLY
The return code indicating that a request was made that requires the object to be writable and the object was in a read-only state.

See Also:
Constant Field Values

OBJECT_MUST_BE_OPEN

public static final int OBJECT_MUST_BE_OPEN
The return code indicating that a request was made that requires the object to be open and the object was not in an open state.

See Also:
Constant Field Values

PROPERTY_NOT_SET

public static final int PROPERTY_NOT_SET
The return code indicating that one or more properties have not been set.

See Also:
Constant Field Values

PROPERTY_NOT_CHANGED

public static final int PROPERTY_NOT_CHANGED
The return code indicating that the property cannot be changed. This usually results when an object is in a state where the property cannot be changed.

See Also:
Constant Field Values

PROXY_SERVER_ALREADY_STARTED

public static final int PROXY_SERVER_ALREADY_STARTED
The return code indicating that the proxy server has already been started.

See Also:
Constant Field Values

PROXY_SERVER_NOT_STARTED

public static final int PROXY_SERVER_NOT_STARTED
The return code indicating that the proxy server has not been started.

See Also:
Constant Field Values

PROXY_SERVER_EVENT_NOT_FIRED

public static final int PROXY_SERVER_EVENT_NOT_FIRED
The return code indicating that the proxy server did not fire an event because the listener was not accessible.

See Also:
Constant Field Values

OBJECT_CAN_NOT_START_THREADS

public static final int OBJECT_CAN_NOT_START_THREADS
The return code indicating that this object is not allowed to start threads.

See Also:
Constant Field Values

SIGNON_ALREADY_IN_PROGRESS

public static final int SIGNON_ALREADY_IN_PROGRESS
The return code indicating that a signon is already in progress.

See Also:
Constant Field Values

UNKNOWN

public static final int UNKNOWN
The return code indicating that the exact cause of the failure is not known. The detailed message may contain additional information.

See Also:
Constant Field Values
Constructor Detail

ExtendedIllegalStateException

public ExtendedIllegalStateException(int returnCode)
Constructs an ExtendedIllegalStateException object. It indicates that an object is not in the proper state to perform the requested operation.

Parameters:
returnCode - The return code which identifies the message to be returned.

ExtendedIllegalStateException

public ExtendedIllegalStateException(String property,
                                     int returnCode)
Constructs an ExtendedIllegalStateException object. It indicates that an object is not in the proper state to perform the requested operation.

Parameters:
property - The property that was not set.
returnCode - The return code which identifies the message to be returned.
Method Detail

getReturnCode

public int getReturnCode()
Returns the return code associated with this exception.

Specified by:
getReturnCode in interface ReturnCodeException
Returns:
The return code.