All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.workflow.api.FmcException

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----com.ibm.workflow.api.FmcException

public final class FmcException
extends Exception
implements Serializable

An instance of this class is thrown if an API error or a communication error occurs. In the former case, the public member rc contains the API error code which will be one of the constants listed below. In the latter case, rc will be set to FMC_ERROR_COMMUNICATION and the public member nestedException will be set to either the CORBA or RMI exception that occured.

Remark: The nested exception can be inspected by (down-)casting to either org.omg.CORBA.SystemException or to java.rmi.RemoteException depending on the used communication protocol. However, doing so will make the client code protocol-dependent (unless it deals with both cases). Note that when using local bindings the nested exception will always be null.

Version:
3.2.0.2

Variable Index

 o FMC_ERROR
 o FMC_ERROR_ALREADY_LOGGED_ON
 o FMC_ERROR_ALREADY_STARTED
 o FMC_ERROR_BACK_LEVEL_VERSION
 o FMC_ERROR_BUFFER
 o FMC_ERROR_CHECKOUT_NOT_POSSIBLE
 o FMC_ERROR_COMMUNICATION
 o FMC_ERROR_DOES_NOT_EXIST
 o FMC_ERROR_EMPTY
 o FMC_ERROR_FORMAT
 o FMC_ERROR_INTERNAL
 o FMC_ERROR_INVALID_ABSENCE_SPEC
 o FMC_ERROR_INVALID_ACTIVITY
 o FMC_ERROR_INVALID_CONFIGURATION_ID
 o FMC_ERROR_INVALID_CORRELATION_ID
 o FMC_ERROR_INVALID_DESCRIPTION
 o FMC_ERROR_INVALID_FILTER
 o FMC_ERROR_INVALID_HANDLE
 o FMC_ERROR_INVALID_IMPLEMENTATION_TYPE
 o FMC_ERROR_INVALID_LIST_TYPE
 o FMC_ERROR_INVALID_NAME
 o FMC_ERROR_INVALID_OID
 o FMC_ERROR_INVALID_PES
 o FMC_ERROR_INVALID_PES_FROM_MODEL
 o FMC_ERROR_INVALID_PROGRAMID
 o FMC_ERROR_INVALID_QUEUE_SCOPE
 o FMC_ERROR_INVALID_RESULT_HANDLE
 o FMC_ERROR_INVALID_SESSION
 o FMC_ERROR_INVALID_SESSION_MODE
 o FMC_ERROR_INVALID_SORT
 o FMC_ERROR_INVALID_SPECIFICATION
 o FMC_ERROR_INVALID_SYSTEM_FROM_CTNR
 o FMC_ERROR_INVALID_SYSTEM_FROM_MODEL
 o FMC_ERROR_INVALID_THRESHOLD
 o FMC_ERROR_INVALID_TIME
 o FMC_ERROR_INVALID_TOOL
 o FMC_ERROR_INVALID_USER
 o FMC_ERROR_INVALID_USER_CONTEXT
 o FMC_ERROR_MEMBER_CANNOT_BE_SET
 o FMC_ERROR_MEMBER_INVALID
 o FMC_ERROR_MEMBER_NOT_FOUND
 o FMC_ERROR_MEMBER_NOT_SET
 o FMC_ERROR_MESSAGE_CATALOG
 o FMC_ERROR_MESSAGE_DATA
 o FMC_ERROR_MESSAGE_FORMAT
 o FMC_ERROR_MIGRATION_NO_SUBPROCESS
 o FMC_ERROR_MIGRATION_OF_CHECKEDOUT_SUSPENDED
 o FMC_ERROR_MIGRATION_OF_RUNNING_PROGRAM
 o FMC_ERROR_NEW_OWNER_ABSENT
 o FMC_ERROR_NEW_OWNER_NOT_FOUND
 o FMC_ERROR_NEWER_VERSION
 o FMC_ERROR_NO_CTNR_ACCESS
 o FMC_ERROR_NO_MANUAL_EXIT
 o FMC_ERROR_NO_MORE_DATA
 o FMC_ERROR_NO_OLD_OWNER
 o FMC_ERROR_NO_PEA_FOUND_FOR_AUTO_START
 o FMC_ERROR_NO_SYS_ADMIN
 o FMC_ERROR_NO_VERSION_2_FILTER
 o FMC_ERROR_NON_LOCAL_USER
 o FMC_ERROR_NOT_ALLOWED
 o FMC_ERROR_NOT_AUTHORIZED
 o FMC_ERROR_NOT_EMPTY
 o FMC_ERROR_NOT_LOGGED_ON
 o FMC_ERROR_NOT_SUPPORTED
 o FMC_ERROR_NOT_UNIQUE
 o FMC_ERROR_OLD_OWNER_ABSENT
 o FMC_ERROR_OWNER_ALREADY_ASSIGNED
 o FMC_ERROR_OWNER_NOT_FOUND
 o FMC_ERROR_PASSWORD
 o FMC_ERROR_PEA_NOT_LOCAL
 o FMC_ERROR_PEA_NOT_LOGGED_ON
 o FMC_ERROR_PEA_NOT_RUNNING
 o FMC_ERROR_PROFILE
 o FMC_ERROR_PROGRAM_EXECUTION
 o FMC_ERROR_PROGRAM_NOT_DEFINED
 o FMC_ERROR_PROGRAM_UNDEFINED
 o FMC_ERROR_PROTOCOL
 o FMC_ERROR_QRY_RESULT_TOO_LARGE
 o FMC_ERROR_RESOURCE
 o FMC_ERROR_SERVER
 o FMC_ERROR_SIZE_EXCEEDED
 o FMC_ERROR_SUB_PROC_TERMINATED_BY_ERROR
 o FMC_ERROR_TIMEOUT
 o FMC_ERROR_TOOL_FUNCTION
 o FMC_ERROR_UNKNOWN
 o FMC_ERROR_USERID_UNKNOWN
 o FMC_ERROR_WRONG_ACT_IMPL_KIND
 o FMC_ERROR_WRONG_KIND
 o FMC_ERROR_WRONG_STATE
 o FMC_ERROR_WRONG_TYPE
 o messageText
The NLS text string describing the API error.
 o nestedException
The exception thrown by the communication layer.
 o origin
The string describing the source code location where the API error occurred.
 o parameters
The string array holding the parameters which were passed when the API error occurred.
 o rc
The API error return code.

Constructor Index

 o FmcException()
Used internally to construct an exception.
 o FmcException(FmcException)
Used internally to construct an exception.
 o FmcException(FmcException)
Used internally to construct an exception.
 o FmcException(FmcException)
Used internally to construct an exception.
 o FmcException(int, String, String[], String)
Used internally to construct an exception.
 o FmcException(RemoteException)
Used internally to construct an exception.
 o FmcException(SystemException)
Used internally to construct an exception.

Method Index

 o getMessage()
Returns a description of the exception.

Variables

 o rc
 public int rc
The API error return code. This numeric value is one of the FMC_ERROR_... constants.

 o origin
 public String origin
The string describing the source code location where the API error occurred.

 o parameters
 public String parameters[]
The string array holding the parameters which were passed when the API error occurred.

 o messageText
 public String messageText
The NLS text string describing the API error.

 o nestedException
 public Throwable nestedException
The exception thrown by the communication layer.

 o FMC_ERROR
 public static final int FMC_ERROR
 o FMC_ERROR_USERID_UNKNOWN
 public static final int FMC_ERROR_USERID_UNKNOWN
 o FMC_ERROR_ALREADY_LOGGED_ON
 public static final int FMC_ERROR_ALREADY_LOGGED_ON
 o FMC_ERROR_PASSWORD
 public static final int FMC_ERROR_PASSWORD
 o FMC_ERROR_COMMUNICATION
 public static final int FMC_ERROR_COMMUNICATION
 o FMC_ERROR_TIMEOUT
 public static final int FMC_ERROR_TIMEOUT
 o FMC_ERROR_INTERNAL
 public static final int FMC_ERROR_INTERNAL
 o FMC_ERROR_SERVER
 public static final int FMC_ERROR_SERVER
 o FMC_ERROR_UNKNOWN
 public static final int FMC_ERROR_UNKNOWN
 o FMC_ERROR_MESSAGE_FORMAT
 public static final int FMC_ERROR_MESSAGE_FORMAT
 o FMC_ERROR_MESSAGE_DATA
 public static final int FMC_ERROR_MESSAGE_DATA
 o FMC_ERROR_RESOURCE
 public static final int FMC_ERROR_RESOURCE
 o FMC_ERROR_NOT_LOGGED_ON
 public static final int FMC_ERROR_NOT_LOGGED_ON
 o FMC_ERROR_NEW_OWNER_NOT_FOUND
 public static final int FMC_ERROR_NEW_OWNER_NOT_FOUND
 o FMC_ERROR_NO_OLD_OWNER
 public static final int FMC_ERROR_NO_OLD_OWNER
 o FMC_ERROR_OLD_OWNER_ABSENT
 public static final int FMC_ERROR_OLD_OWNER_ABSENT
 o FMC_ERROR_NEW_OWNER_ABSENT
 public static final int FMC_ERROR_NEW_OWNER_ABSENT
 o FMC_ERROR_ALREADY_STARTED
 public static final int FMC_ERROR_ALREADY_STARTED
 o FMC_ERROR_MEMBER_NOT_FOUND
 public static final int FMC_ERROR_MEMBER_NOT_FOUND
 o FMC_ERROR_MEMBER_NOT_SET
 public static final int FMC_ERROR_MEMBER_NOT_SET
 o FMC_ERROR_WRONG_TYPE
 public static final int FMC_ERROR_WRONG_TYPE
 o FMC_ERROR_MEMBER_CANNOT_BE_SET
 public static final int FMC_ERROR_MEMBER_CANNOT_BE_SET
 o FMC_ERROR_MEMBER_INVALID
 public static final int FMC_ERROR_MEMBER_INVALID
 o FMC_ERROR_FORMAT
 public static final int FMC_ERROR_FORMAT
 o FMC_ERROR_DOES_NOT_EXIST
 public static final int FMC_ERROR_DOES_NOT_EXIST
 o FMC_ERROR_NOT_AUTHORIZED
 public static final int FMC_ERROR_NOT_AUTHORIZED
 o FMC_ERROR_WRONG_STATE
 public static final int FMC_ERROR_WRONG_STATE
 o FMC_ERROR_NOT_UNIQUE
 public static final int FMC_ERROR_NOT_UNIQUE
 o FMC_ERROR_EMPTY
 public static final int FMC_ERROR_EMPTY
 o FMC_ERROR_NO_MANUAL_EXIT
 public static final int FMC_ERROR_NO_MANUAL_EXIT
 o FMC_ERROR_PROFILE
 public static final int FMC_ERROR_PROFILE
 o FMC_ERROR_INVALID_FILTER
 public static final int FMC_ERROR_INVALID_FILTER
 o FMC_ERROR_PROGRAM_EXECUTION
 public static final int FMC_ERROR_PROGRAM_EXECUTION
 o FMC_ERROR_PROTOCOL
 public static final int FMC_ERROR_PROTOCOL
 o FMC_ERROR_TOOL_FUNCTION
 public static final int FMC_ERROR_TOOL_FUNCTION
 o FMC_ERROR_INVALID_TOOL
 public static final int FMC_ERROR_INVALID_TOOL
 o FMC_ERROR_INVALID_HANDLE
 public static final int FMC_ERROR_INVALID_HANDLE
 o FMC_ERROR_NOT_EMPTY
 public static final int FMC_ERROR_NOT_EMPTY
 o FMC_ERROR_INVALID_USER
 public static final int FMC_ERROR_INVALID_USER
 o FMC_ERROR_OWNER_ALREADY_ASSIGNED
 public static final int FMC_ERROR_OWNER_ALREADY_ASSIGNED
 o FMC_ERROR_INVALID_NAME
 public static final int FMC_ERROR_INVALID_NAME
 o FMC_ERROR_INVALID_PROGRAMID
 public static final int FMC_ERROR_INVALID_PROGRAMID
 o FMC_ERROR_SIZE_EXCEEDED
 public static final int FMC_ERROR_SIZE_EXCEEDED
 o FMC_ERROR_WRONG_ACT_IMPL_KIND
 public static final int FMC_ERROR_WRONG_ACT_IMPL_KIND
 o FMC_ERROR_NON_LOCAL_USER
 public static final int FMC_ERROR_NON_LOCAL_USER
 o FMC_ERROR_WRONG_KIND
 public static final int FMC_ERROR_WRONG_KIND
 o FMC_ERROR_INVALID_ACTIVITY
 public static final int FMC_ERROR_INVALID_ACTIVITY
 o FMC_ERROR_CHECKOUT_NOT_POSSIBLE
 public static final int FMC_ERROR_CHECKOUT_NOT_POSSIBLE
 o FMC_ERROR_BACK_LEVEL_VERSION
 public static final int FMC_ERROR_BACK_LEVEL_VERSION
 o FMC_ERROR_NEWER_VERSION
 public static final int FMC_ERROR_NEWER_VERSION
 o FMC_ERROR_INVALID_CORRELATION_ID
 public static final int FMC_ERROR_INVALID_CORRELATION_ID
 o FMC_ERROR_NOT_ALLOWED
 public static final int FMC_ERROR_NOT_ALLOWED
 o FMC_ERROR_BUFFER
 public static final int FMC_ERROR_BUFFER
 o FMC_ERROR_INVALID_SESSION
 public static final int FMC_ERROR_INVALID_SESSION
 o FMC_ERROR_INVALID_TIME
 public static final int FMC_ERROR_INVALID_TIME
 o FMC_ERROR_NO_MORE_DATA
 public static final int FMC_ERROR_NO_MORE_DATA
 o FMC_ERROR_INVALID_OID
 public static final int FMC_ERROR_INVALID_OID
 o FMC_ERROR_INVALID_THRESHOLD
 public static final int FMC_ERROR_INVALID_THRESHOLD
 o FMC_ERROR_INVALID_SORT
 public static final int FMC_ERROR_INVALID_SORT
 o FMC_ERROR_INVALID_DESCRIPTION
 public static final int FMC_ERROR_INVALID_DESCRIPTION
 o FMC_ERROR_INVALID_IMPLEMENTATION_TYPE
 public static final int FMC_ERROR_INVALID_IMPLEMENTATION_TYPE
 o FMC_ERROR_OWNER_NOT_FOUND
 public static final int FMC_ERROR_OWNER_NOT_FOUND
 o FMC_ERROR_INVALID_LIST_TYPE
 public static final int FMC_ERROR_INVALID_LIST_TYPE
 o FMC_ERROR_INVALID_RESULT_HANDLE
 public static final int FMC_ERROR_INVALID_RESULT_HANDLE
 o FMC_ERROR_MESSAGE_CATALOG
 public static final int FMC_ERROR_MESSAGE_CATALOG
 o FMC_ERROR_INVALID_SPECIFICATION
 public static final int FMC_ERROR_INVALID_SPECIFICATION
 o FMC_ERROR_QRY_RESULT_TOO_LARGE
 public static final int FMC_ERROR_QRY_RESULT_TOO_LARGE
 o FMC_ERROR_NO_VERSION_2_FILTER
 public static final int FMC_ERROR_NO_VERSION_2_FILTER
 o FMC_ERROR_INVALID_USER_CONTEXT
 public static final int FMC_ERROR_INVALID_USER_CONTEXT
 o FMC_ERROR_NO_SYS_ADMIN
 public static final int FMC_ERROR_NO_SYS_ADMIN
 o FMC_ERROR_INVALID_SESSION_MODE
 public static final int FMC_ERROR_INVALID_SESSION_MODE
 o FMC_ERROR_PROGRAM_UNDEFINED
 public static final int FMC_ERROR_PROGRAM_UNDEFINED
 o FMC_ERROR_PEA_NOT_RUNNING
 public static final int FMC_ERROR_PEA_NOT_RUNNING
 o FMC_ERROR_PEA_NOT_LOCAL
 public static final int FMC_ERROR_PEA_NOT_LOCAL
 o FMC_ERROR_INVALID_ABSENCE_SPEC
 public static final int FMC_ERROR_INVALID_ABSENCE_SPEC
 o FMC_ERROR_NOT_SUPPORTED
 public static final int FMC_ERROR_NOT_SUPPORTED
 o FMC_ERROR_PROGRAM_NOT_DEFINED
 public static final int FMC_ERROR_PROGRAM_NOT_DEFINED
 o FMC_ERROR_PEA_NOT_LOGGED_ON
 public static final int FMC_ERROR_PEA_NOT_LOGGED_ON
 o FMC_ERROR_INVALID_PES
 public static final int FMC_ERROR_INVALID_PES
 o FMC_ERROR_INVALID_PES_FROM_MODEL
 public static final int FMC_ERROR_INVALID_PES_FROM_MODEL
 o FMC_ERROR_INVALID_SYSTEM_FROM_CTNR
 public static final int FMC_ERROR_INVALID_SYSTEM_FROM_CTNR
 o FMC_ERROR_INVALID_SYSTEM_FROM_MODEL
 public static final int FMC_ERROR_INVALID_SYSTEM_FROM_MODEL
 o FMC_ERROR_SUB_PROC_TERMINATED_BY_ERROR
 public static final int FMC_ERROR_SUB_PROC_TERMINATED_BY_ERROR
 o FMC_ERROR_NO_PEA_FOUND_FOR_AUTO_START
 public static final int FMC_ERROR_NO_PEA_FOUND_FOR_AUTO_START
 o FMC_ERROR_NO_CTNR_ACCESS
 public static final int FMC_ERROR_NO_CTNR_ACCESS
 o FMC_ERROR_INVALID_CONFIGURATION_ID
 public static final int FMC_ERROR_INVALID_CONFIGURATION_ID
 o FMC_ERROR_MIGRATION_OF_RUNNING_PROGRAM
 public static final int FMC_ERROR_MIGRATION_OF_RUNNING_PROGRAM
 o FMC_ERROR_MIGRATION_OF_CHECKEDOUT_SUSPENDED
 public static final int FMC_ERROR_MIGRATION_OF_CHECKEDOUT_SUSPENDED
 o FMC_ERROR_MIGRATION_NO_SUBPROCESS
 public static final int FMC_ERROR_MIGRATION_NO_SUBPROCESS
 o FMC_ERROR_INVALID_QUEUE_SCOPE
 public static final int FMC_ERROR_INVALID_QUEUE_SCOPE

Constructors

 o FmcException
 public FmcException()
Used internally to construct an exception.

 o FmcException
 public FmcException(int rc,
                     String origin,
                     String parameters[],
                     String messageText)
Used internally to construct an exception.

Parameters:
rc - the API return code
origin - the string describing the source code location where the API error occurred
parameters - the string array holding the parameters which were passed when the API error occurred
messageText - the NLS text describing the API error
 o FmcException
 public FmcException(FmcException ce)
Used internally to construct an exception.

Parameters:
ce - the CORBA exception
 o FmcException
 public FmcException(FmcException le)
Used internally to construct an exception.

Parameters:
le - the local exception
 o FmcException
 public FmcException(FmcException re)
Used internally to construct an exception.

Parameters:
re - the Java RMI remote exception
 o FmcException
 public FmcException(SystemException se)
Used internally to construct an exception.

Parameters:
se - the CORBA system exception
 o FmcException
 public FmcException(RemoteException re)
Used internally to construct an exception.

Parameters:
re - the Java RMI remote exception

Methods

 o getMessage
 public String getMessage()
Returns a description of the exception.

Returns:
the description string
Overrides:
getMessage in class Throwable

All Packages  Class Hierarchy  This Package  Previous  Next  Index