com.progress.open4gl

Class RunTime4GLException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.progress.common.exception.ProException

com.progress.open4gl.Open4GLException

com.progress.open4gl.RunTime4GLException

All Implemented Interfaces:

com.progress.common.exception.IChainableException, java.io.Serializable

Direct Known Subclasses:

RunTime4GLErrorException, RunTime4GLQuitException, RunTime4GLStopException

public class RunTime4GLException
extends Open4GLException

The RunTime4GLException family of exceptions correspond to ABL ERROR, STOP, and QUIT conditions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RunTime4GLException(long id, java.lang.Object[] args, int err) This constructor is intended for internal use only.

Method Summary

Modifier and Type	Method and Description
static RunTime4GLException	createException(int condition, int errorNum, java.lang.String errorString, java.lang.String retStr, boolean noRet) This method is intended for internal use only.
int	getErrorNum() This returns the ABL error number.
java.lang.String	getProcReturnString() Get the RETURN-VALUE (or ReturnValue) that was set by the last procedure call.
boolean	hasProcReturnString() This method returns true if ABL was called and executed RETURN ERROR [<string>], RETURN ERROR <AppError>, or UNDO, THROW <AppError> with an UNDO, THROW directive in the top-level ABL procedure.
void	setProcReturnString(java.lang.String returnStr) This method is intended for internal use only.

Methods inherited from class com.progress.common.exception.ProException

getArgument, getLocalizedMessage, getMessage, getMessageId, getPrevious, setMessageId, setPrevious, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RunTime4GLException

public RunTime4GLException(long id,
                           java.lang.Object[] args,
                           int err)

This constructor is intended for internal use only.

Method Detail

createException

public static RunTime4GLException createException(int condition,
                                                  int errorNum,
                                                  java.lang.String errorString,
                                                  java.lang.String retStr,
                                                  boolean noRet)

This method is intended for internal use only.

getErrorNum

public int getErrorNum()

This returns the ABL error number. If there is more than one error message, this is the number associated with the first error.

Returns:

The error number of the first error

setProcReturnString

public void setProcReturnString(java.lang.String returnStr)

This method is intended for internal use only.

Overrides:

setProcReturnString in class Open4GLException

hasProcReturnString

public boolean hasProcReturnString()

This method returns true if ABL was called and executed RETURN ERROR [<string>], RETURN ERROR <AppError>, or UNDO, THROW <AppError> with an UNDO, THROW directive in the top-level ABL procedure. If an error occurs before any ABL code ever executes this will return false.

Overrides:

hasProcReturnString in class Open4GLException

Returns:

true if there is a RETURN-VALUE (or ReturnValue), otherwise false.

getProcReturnString

public java.lang.String getProcReturnString()

Get the RETURN-VALUE (or ReturnValue) that was set by the last procedure call.

Overrides:

getProcReturnString in class Open4GLException

Returns:

The RETURN-VALUE (or ReturnValue) value. If hasProcReturnString returns false, this method returns null. If RETURN ERROR was executed with no <string> or if an AppError is thrown and the ReturnValue property was not set, this returns the empty string. If the Unknown value (?) was explicitly set (for example, RETURN ERROR ?), this method returns null.