com.ibm.etools.sfm.sfpi
Class SFException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.etools.sfm.sfpi.SFException
All Implemented Interfaces:
java.io.Serializable

public class SFException
extends java.lang.Exception

SFException is a class that covers the possible errors that can occur when using the SFPI.

See Also:
Serialized Form

Field Summary
static int WZEF1000E_INTERNALERROR
          An unexpected error occurred.
static int WZEF1001E_ARGSERROR
          Illegal arguments.
static int WZEF1100E_NAMENOTVALID
          The message or element name is not valid.
static int WZEF1101W_COBOLNAMENOTVALID
          The message or element name is not a valid COBOL variable name.
static int WZEF1102E_NAMEALREADYINUSE
          The message or element name is already in use.
static int WZEF1103E_MESSAGENOTNAMED
          The message is not named.
static int WZEF1104E_MESSAGENAMECONFLICT
          The message file contains at least two messages with the same name.
static int WZEF1200E_NAMENOTVALID
          The operation name is not a valid NCName.
static int WZEF1201E_CHANNELTYPEMISMATCH
          An attempt to add a non-channel input or output to a channel operation or an attempt to add a channel input or output to a non-channel operation was detected.
static int WZEF1202E_OPERATIONNOTNAMED
          The operation is not named.
static int WZEF1203E_OPERATIONHASNOINPUT
          The operation has no input.
static int WZEF1204E_OPERATIONHASNOOUTPUT
          The operation has no output.
static int WZEF1205E_BADMESSAGEREF
          The operations file references a message that is not associated with a message file.
static int WZEF1206E_OPERATIONNAMECONFLICT
          The operations file contains at least two operations with the same name.
static int WZEF1300E_FILENAMENOTVALID
          The file name is not valid.
static int WZEF1301E_FILESAVEFAILED
          The file save failed.
static int WZEF1400E_INVOKETYPENOTVALID
          The invoke type is not valid.
static int WZEF1401E_RUNTIMENOTVALID
          The runtime is not valid.
static int WZEF1402E_RUNTIMENOTSUPPORTED
          The given runtime is not supported for the invoke type.
static int WZEF1403E_INPUTMESSAGENOTFOUND
          An attempt to access or modify the container properties of a message that is not an input message of the associated channel operation was detected.
static int WZEF1404E_OUTPUTMESSAGENOTFOUND
          An attempt to access or modify the container properties of a message that is not an output message of the associated channel operation was detected.
static int WZEF1405E_RESTRICTEDCONTAINERNAME
          The container name is not allowed.
static int WZEF1406E_INVOKETYPEMISMATCH
          An attempt to associate a channel operation with non-channel invoke type generation properties, or an attempt to associate a non-channel operation with channel invoke type generation properties, was detected.
static int WZEF1407E_PROPERTYVALIDATIONFAILED
          Validation of the property value failed.
 
Constructor Summary
SFException(int reasonCode)
          Creates a SFException with the given reason.
SFException(int reasonCode, java.lang.Throwable cause)
          Creates a SFException with the given reason code and cause
 
Method Summary
 java.lang.String getMessage()
          Returns a message explaining the exception.
 int getReasonCode()
          Returns the exception's reason code.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

WZEF1000E_INTERNALERROR

public static final int WZEF1000E_INTERNALERROR
An unexpected error occurred.

See Also:
Constant Field Values

WZEF1001E_ARGSERROR

public static final int WZEF1001E_ARGSERROR
Illegal arguments.

See Also:
Constant Field Values

WZEF1100E_NAMENOTVALID

public static final int WZEF1100E_NAMENOTVALID
The message or element name is not valid. A message or element name must not contain spaces or the colon (':') character. A message or element name must begin with either a letter or an underscore ('_') character.

See Also:
Constant Field Values

WZEF1101W_COBOLNAMENOTVALID

public static final int WZEF1101W_COBOLNAMENOTVALID
The message or element name is not a valid COBOL variable name. Either the name is illegal in COBOL or it matches a COBOL reserved word.

See Also:
Constant Field Values

WZEF1102E_NAMEALREADYINUSE

public static final int WZEF1102E_NAMEALREADYINUSE
The message or element name is already in use.

See Also:
Constant Field Values

WZEF1103E_MESSAGENOTNAMED

public static final int WZEF1103E_MESSAGENOTNAMED
The message is not named.

See Also:
Constant Field Values

WZEF1104E_MESSAGENAMECONFLICT

public static final int WZEF1104E_MESSAGENAMECONFLICT
The message file contains at least two messages with the same name.

See Also:
Constant Field Values

WZEF1200E_NAMENOTVALID

public static final int WZEF1200E_NAMENOTVALID
The operation name is not a valid NCName.

See Also:
Constant Field Values

WZEF1201E_CHANNELTYPEMISMATCH

public static final int WZEF1201E_CHANNELTYPEMISMATCH
An attempt to add a non-channel input or output to a channel operation or an attempt to add a channel input or output to a non-channel operation was detected.

See Also:
Constant Field Values

WZEF1202E_OPERATIONNOTNAMED

public static final int WZEF1202E_OPERATIONNOTNAMED
The operation is not named.

See Also:
Constant Field Values

WZEF1203E_OPERATIONHASNOINPUT

public static final int WZEF1203E_OPERATIONHASNOINPUT
The operation has no input.

See Also:
Constant Field Values

WZEF1204E_OPERATIONHASNOOUTPUT

public static final int WZEF1204E_OPERATIONHASNOOUTPUT
The operation has no output.

See Also:
Constant Field Values

WZEF1205E_BADMESSAGEREF

public static final int WZEF1205E_BADMESSAGEREF
The operations file references a message that is not associated with a message file.

See Also:
Constant Field Values

WZEF1206E_OPERATIONNAMECONFLICT

public static final int WZEF1206E_OPERATIONNAMECONFLICT
The operations file contains at least two operations with the same name.

See Also:
Constant Field Values

WZEF1300E_FILENAMENOTVALID

public static final int WZEF1300E_FILENAMENOTVALID
The file name is not valid.

See Also:
Constant Field Values

WZEF1301E_FILESAVEFAILED

public static final int WZEF1301E_FILESAVEFAILED
The file save failed.

See Also:
Constant Field Values

WZEF1400E_INVOKETYPENOTVALID

public static final int WZEF1400E_INVOKETYPENOTVALID
The invoke type is not valid. The invoke type must be one of InvokeType_COMMAREA, InvokeType_Channel, and InvokeType_MQSeries.

See Also:
Constant Field Values

WZEF1401E_RUNTIMENOTVALID

public static final int WZEF1401E_RUNTIMENOTVALID
The runtime is not valid. The runtime must be one of Runtime_CSFR31 and Runtime_CSFR32.

See Also:
Constant Field Values

WZEF1402E_RUNTIMENOTSUPPORTED

public static final int WZEF1402E_RUNTIMENOTSUPPORTED
The given runtime is not supported for the invoke type.

See Also:
Constant Field Values

WZEF1403E_INPUTMESSAGENOTFOUND

public static final int WZEF1403E_INPUTMESSAGENOTFOUND
An attempt to access or modify the container properties of a message that is not an input message of the associated channel operation was detected.

See Also:
Constant Field Values

WZEF1404E_OUTPUTMESSAGENOTFOUND

public static final int WZEF1404E_OUTPUTMESSAGENOTFOUND
An attempt to access or modify the container properties of a message that is not an output message of the associated channel operation was detected.

See Also:
Constant Field Values

WZEF1405E_RESTRICTEDCONTAINERNAME

public static final int WZEF1405E_RESTRICTEDCONTAINERNAME
The container name is not allowed. The container name must not be one of "ADAPTER.PROCESS", "ADAPTER.ERROR", "COMMAND.STATUS", "COMMAND.INPUT", "COMMAND.OUTPUT", or "DPL.DATA".

See Also:
Constant Field Values

WZEF1406E_INVOKETYPEMISMATCH

public static final int WZEF1406E_INVOKETYPEMISMATCH
An attempt to associate a channel operation with non-channel invoke type generation properties, or an attempt to associate a non-channel operation with channel invoke type generation properties, was detected.

See Also:
Constant Field Values

WZEF1407E_PROPERTYVALIDATIONFAILED

public static final int WZEF1407E_PROPERTYVALIDATIONFAILED
Validation of the property value failed. The specified value for the property contains characters that are not valid.

See Also:
Constant Field Values
Constructor Detail

SFException

public SFException(int reasonCode)
Creates a SFException with the given reason.

Parameters:
reasonCode - The reason for the exception.

SFException

public SFException(int reasonCode,
                   java.lang.Throwable cause)
Creates a SFException with the given reason code and cause

Parameters:
reasonCode - The reason code for the exception.
cause - The cause of the exception.
Method Detail

getReasonCode

public int getReasonCode()
Returns the exception's reason code.

Returns:
The reason code for the exception.

getMessage

public java.lang.String getMessage()
Returns a message explaining the exception.

Overrides:
getMessage in class java.lang.Throwable
Returns:
The message for the exception.