com.goldencode.p2j.oo.lang

Class AppError

java.lang.Object

com.goldencode.p2j.oo.lang.BaseObject

com.goldencode.p2j.oo.lang.ProError

com.goldencode.p2j.oo.lang.AppError

All Implemented Interfaces:

_BaseObject_, LegacyError, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

AbstractAssertionFailedError, ApplicationError, DataAdminError, DataProviderError, FixtureCreateError, FixtureError

public class AppError
extends ProError

Implementation of the Progress.Lang.AppError builtin class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	fromReturn Flag indicating if this originates from a RETURN ERROR statement.
private character	returnValue The return value.

Fields inherited from class com.goldencode.p2j.oo.lang.ProError

errors

Constructor Summary

Constructors

Constructor and Description
AppError()

Method Summary

Modifier and Type	Method and Description
void	__lang_AppError_constructor__() Implicit, no parameter, method associated with the implicit legacy constructor for the Progress.Lang.AppError class.
void	__lang_AppError_constructor__(character _retVal) Explicit method associated with a legacy constructor for the Progress.Lang.AppError class.
void	__lang_AppError_constructor__(character _msg, integer _num) Explicit method associated with a legacy constructor for the Progress.Lang.AppError class.
void	addMessage(character msg, integer num) Implementation of the AddMessage legacy method.
character	getReturnValue() Get the returnValue property.
boolean	isFromReturn() Get the state of the fromReturn flag.
static object<AppError>	newInstance(character retVal) Create a new AppError instance and return it as a legacy object.
static object<AppError>	newInstance(character msg, integer num) Create a new AppError instance and return it as a legacy object.
static object<AppError>	newInstance(java.lang.String msg, int num) Create a new AppError instance and return it as a legacy object.
void	readExternal(java.io.ObjectInput in) The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
void	removeMessage(integer idx) Implementation of the RemoveMessage legacy method.
void	setFromReturn(boolean state) Set the state of the fromReturn flag.
void	setReturnValue(character val) Set the returnValue property.
void	writeExternal(java.io.ObjectOutput out) The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Methods inherited from class com.goldencode.p2j.oo.lang.ProError

__lang_ProError_constructor__, __lang_ProError_constructor__, getCallStack, getMessage, getMessageNum, getNumMessages, getSeverity, populateCallStack, setSeverity, validIndex

Methods inherited from class com.goldencode.p2j.oo.lang.BaseObject

__isValidInternal__, __lang_BaseObject_constructor__, __setValidInternal__, assertNotNull, assertNotNull, getLegacyClass, getNextSibling, getPrevSibling, legacyClone, legacyEquals, toLegacyString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.oo.lang._BaseObject_

__isValidInternal__, __lang_BaseObject_constructor__, __setValidInternal__, getLegacyClass, getNextSibling, getPrevSibling, isTracked, legacyClone, legacyEquals, toLegacyString

Field Detail

returnValue

private character returnValue

The return value.

fromReturn

private boolean fromReturn

Flag indicating if this originates from a RETURN ERROR statement.

Constructor Detail

AppError

public AppError()

Method Detail

newInstance

public static object<AppError> newInstance(character retVal)

Create a new AppError instance and return it as a legacy object.

Parameters:

retVal - The return value.

Returns:

new object instance

newInstance

public static object<AppError> newInstance(character msg,
                                           integer num)

Create a new AppError instance and return it as a legacy object.

Parameters:

msg - The message.

num - The message number.

Returns:

new object instance

newInstance

public static object<AppError> newInstance(java.lang.String msg,
                                           int num)

Create a new AppError instance and return it as a legacy object.

Parameters:

msg - The message.

num - The message number.

Returns:

new object instance

__lang_AppError_constructor__

public void __lang_AppError_constructor__()

Implicit, no parameter, method associated with the implicit legacy constructor for the Progress.Lang.AppError class.

__lang_AppError_constructor__

public void __lang_AppError_constructor__(character _msg,
                                          integer _num)

Explicit method associated with a legacy constructor for the Progress.Lang.AppError class.

Parameters:

_msg - The message.

_num - The message number.

__lang_AppError_constructor__

public void __lang_AppError_constructor__(character _retVal)

Explicit method associated with a legacy constructor for the Progress.Lang.AppError class.

Parameters:

_retVal - The return value.

isFromReturn

public boolean isFromReturn()

Get the state of the fromReturn flag.

Returns:

See above.

setFromReturn

public void setFromReturn(boolean state)

Set the state of the fromReturn flag.

Parameters:

state - true if this error is raised via RETURN ERROR statement.

getReturnValue

public character getReturnValue()

Get the returnValue property.

Returns:

See above.

setReturnValue

public void setReturnValue(character val)

Set the returnValue property.

Parameters:

val - The return value.

removeMessage

public void removeMessage(integer idx)

Implementation of the RemoveMessage legacy method.

Parameters:

idx - The message index to be removed.

addMessage

public void addMessage(character msg,
                       integer num)

Implementation of the AddMessage legacy method.

Overrides:

addMessage in class ProError

Parameters:

msg - The error message.

num - The error message number.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class ProError

Parameters:

out - the stream to write the object to

Throws:

java.io.IOException - Includes any I/O exceptions that may occur

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class ProError

Parameters:

in - the stream to read data from in order to restore the object

Throws:

java.io.IOException - if I/O errors occur

java.lang.ClassNotFoundException - If the class for an object being restored cannot be found.