com.goldencode.p2j.oo.lang

Class ProError

java.lang.Object

com.goldencode.p2j.oo.lang.BaseObject

com.goldencode.p2j.oo.lang.ProError

All Implemented Interfaces:

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

Direct Known Subclasses:

AppError, SysError

public class ProError
extends BaseObject
implements LegacyError, java.io.Externalizable

Implementation of the Progress.Lang.ProError builtin class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	callStack The call stack at the time the error was thrown.
protected java.util.List<NumberedException>	errors The recorded errors.
private integer	severity The severity property.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProError() Implicit constructor used by sub-classes.
	ProError(NumberedException error) Create a new instance with the specified error.
	ProError(NumberedException[] errors) Create a new instance with the specified errors.

Method Summary

Modifier and Type	Method and Description
protected void	__lang_ProError_constructor__() Implicit, no parameter, method associated with the implicit legacy constructor for the Progress.Lang.ProError class.
protected void	__lang_ProError_constructor__(character _msg, integer _num) Explicit method associated with a legacy constructor for the Progress.Lang.ProError class.
void	addMessage(character msg, integer num) Implementation of the AddMessage legacy method.
character	getCallStack() Get the call stack.
character	getMessage(integer idx) Definition of the GetMessage legacy method.
integer	getMessageNum(integer idx) Implementation of the GetMessageNum legacy method.
integer	getNumMessages() Get the number of messages.
integer	getSeverity() Get the error's severity.
void	populateCallStack() Populate the callStack traces.
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	setSeverity(integer s) Set the error's severity.
protected boolean	validIndex(integer idx) Check if the specified index is valid for errors.
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.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

severity

private integer severity

The severity property.

errors

protected java.util.List<NumberedException> errors

The recorded errors.

callStack

private java.lang.String callStack

The call stack at the time the error was thrown.

Constructor Detail

ProError

public ProError(NumberedException error)

Create a new instance with the specified error.

Parameters:

error - The legacy error.

ProError

public ProError(NumberedException[] errors)

Create a new instance with the specified errors.

Parameters:

errors - The legacy errors.

ProError

protected ProError()

Implicit constructor used by sub-classes.

Method Detail

__lang_ProError_constructor__

protected void __lang_ProError_constructor__()

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

__lang_ProError_constructor__

protected void __lang_ProError_constructor__(character _msg,
                                             integer _num)

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

Parameters:

_msg - The message.

_num - The message number.

getNumMessages

public integer getNumMessages()

Get the number of messages.

Specified by:

getNumMessages in interface LegacyError

Returns:

See above.

getCallStack

public character getCallStack()

Get the call stack.

Specified by:

getCallStack in interface LegacyError

Returns:

See above.

populateCallStack

public void populateCallStack()

Populate the callStack traces. Any existing callstack will be assumed to be the server's stacktrace from the remote call.

getSeverity

public integer getSeverity()

Get the error's severity.

Specified by:

getSeverity in interface LegacyError

Returns:

See above.

setSeverity

public void setSeverity(integer s)

Set the error's severity.

Specified by:

setSeverity in interface LegacyError

Parameters:

s - The severity.

getMessage

public character getMessage(integer idx)

Definition of the GetMessage legacy method.

Specified by:

getMessage in interface LegacyError

Parameters:

idx - The message index.

Returns:

The error message for the specified error.

getMessageNum

public integer getMessageNum(integer idx)

Implementation of the GetMessageNum legacy method.

Specified by:

getMessageNum in interface LegacyError

Parameters:

idx - The message index.

Returns:

The error message number for the specified error.

addMessage

public void addMessage(character msg,
                       integer num)

Implementation of the AddMessage legacy method.

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

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

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.

validIndex

protected boolean validIndex(integer idx)

Check if the specified index is valid for errors.

Parameters:

idx - The index.

Returns:

Must be not-unknown and within the size of the errors.