com.ibm.as400.micro
Class MEException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ibm.as400.micro.MEException
All Implemented Interfaces:
java.io.Serializable

public final class MEException
extends java.lang.Exception

The MEException class represents an exception that indicates an error occured while processing the ToolboxME for iSeries request.

See Also:
Serialized Form

Field Summary
static int AS400_SECURITY_EXCEPTION
          This return code indicates that a security or authority error has occurred.
static int CONNECTION_DROPPED
          The return code indicating that the connection was dropped unexpectedly.
static int ILLEGAL_OBJECT_TYPE
          The return code indicating that an attempt was made to use a data queue with an invalid data queue object type.
static int LENGTH_NOT_VALID
          The return code indicating that the iSeries resource has a length that is not valid or cannot be handled through this interface.
static int ME_SERVER_ALREADY_STARTED
          The return code indicating that the MEServer has already been started.
static int ME_SERVER_NOT_STARTED
          The return code indicating that the MEServer has not been started.
static int OBJECT_ALREADY_EXISTS
          The return code indicating that the object already exists.
static int OBJECT_DOES_NOT_EXIST
          The return code indicating that the object does not exist.
static int PARAMETER_VALUE_NOT_VALID
          The return code indicating that the parameter value is not valid.
static int PASSWORD_ERROR
          The return code indicating that there is a general password error.
static int PASSWORD_EXPIRED
          The return code indicating that the password has expired.
static int PASSWORD_INCORRECT
          The return code indicating that the password is not correct.
static int PCML_EXCEPTION
          The return code indicating that a pcml exception occurred.
static int PROGRAM_FAILED
          The return code indicating that the program call failed.
static int PROGRAM_NOT_REGISTERED
          The return code indicating that the pcml document was not registered with the MEServer.
static int PROPERTY_NOT_SET
          The return code indicating that one or more properties have not been set.
static int RESULT_SET_CLOSED
          The return code indicating that the result set is closed.
static int SERVER_NOT_STARTED
          The return code indicating that it was unable to start the server.
static int UNKNOWN
          The return code indicating that an unknown error occurred.
static int UNKNOWN_HOST
          The return code indicating that the host is unknown.
static int USERID_DISABLE
          The return code indicating that the user ID has been disabled by the server.
static int USERID_NOT_SET
          The return code indicating that the user ID is not set.
static int USERID_UNKNOWN
          The return code indicating that the user ID is not known by the server.
 
Method Summary
 int getReturnCode()
          Returns the return code associated with this exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

AS400_SECURITY_EXCEPTION

public static final int AS400_SECURITY_EXCEPTION
This return code indicates that a security or authority error has occurred.

PASSWORD_ERROR

public static final int PASSWORD_ERROR
The return code indicating that there is a general password error.

PASSWORD_EXPIRED

public static final int PASSWORD_EXPIRED
The return code indicating that the password has expired.

PASSWORD_INCORRECT

public static final int PASSWORD_INCORRECT
The return code indicating that the password is not correct.

USERID_NOT_SET

public static final int USERID_NOT_SET
The return code indicating that the user ID is not set.

USERID_DISABLE

public static final int USERID_DISABLE
The return code indicating that the user ID has been disabled by the server.

USERID_UNKNOWN

public static final int USERID_UNKNOWN
The return code indicating that the user ID is not known by the server.

OBJECT_ALREADY_EXISTS

public static final int OBJECT_ALREADY_EXISTS
The return code indicating that the object already exists.

OBJECT_DOES_NOT_EXIST

public static final int OBJECT_DOES_NOT_EXIST
The return code indicating that the object does not exist.

PARAMETER_VALUE_NOT_VALID

public static final int PARAMETER_VALUE_NOT_VALID
The return code indicating that the parameter value is not valid.

PROPERTY_NOT_SET

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

LENGTH_NOT_VALID

public static final int LENGTH_NOT_VALID
The return code indicating that the iSeries resource has a length that is not valid or cannot be handled through this interface.

CONNECTION_DROPPED

public static final int CONNECTION_DROPPED
The return code indicating that the connection was dropped unexpectedly.

SERVER_NOT_STARTED

public static final int SERVER_NOT_STARTED
The return code indicating that it was unable to start the server.

UNKNOWN_HOST

public static final int UNKNOWN_HOST
The return code indicating that the host is unknown.

ME_SERVER_ALREADY_STARTED

public static final int ME_SERVER_ALREADY_STARTED
The return code indicating that the MEServer has already been started.

ME_SERVER_NOT_STARTED

public static final int ME_SERVER_NOT_STARTED
The return code indicating that the MEServer has not been started.

PROGRAM_NOT_REGISTERED

public static final int PROGRAM_NOT_REGISTERED
The return code indicating that the pcml document was not registered with the MEServer.

PROGRAM_FAILED

public static final int PROGRAM_FAILED
The return code indicating that the program call failed.

ILLEGAL_OBJECT_TYPE

public static final int ILLEGAL_OBJECT_TYPE
The return code indicating that an attempt was made to use a data queue with an invalid data queue object type.

PCML_EXCEPTION

public static final int PCML_EXCEPTION
The return code indicating that a pcml exception occurred.

UNKNOWN

public static final int UNKNOWN
The return code indicating that an unknown error occurred.

RESULT_SET_CLOSED

public static final int RESULT_SET_CLOSED
The return code indicating that the result set is closed.
Method Detail

getReturnCode

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