com.goldencode.p2j.util

Interface CommonErrorStatus

All Superinterfaces:

CommonHandle, Errorable, ErrorString, PseudoWidget, WrappedResource

All Known Subinterfaces:

HandleCommon

public interface CommonErrorStatus
extends CommonHandle, Errorable, ErrorString, PseudoWidget

Exposes the following methods or attributes from the ERROR-STATUS handle:

ERROR-STATUS attribute or method	API
NUM-MESSAGES	numErrors()
GET-MESSAGE(n)	getErrorText(int) and getErrorText(integer)
GET-NUMBER(n)	getErrorNumber(int) and getErrorNumber(integer)

This interface is used as a returned type by the handle.unwrapErrorStatus() API, which, depending on the handle's state, it either returns an ErrorManager.asHandle() instance or an dynamic proxy using handle.invalidAttrAccessProxy

Method Summary

Modifier and Type	Method and Description
integer	getErrorNumber(int index) Returns the Progress compatible error number associated with the error entry at the given index in the error list.
integer	getErrorNumber(integer index) Returns the Progress compatible error number associated with the error entry at the given index in the error list.
handle	getErrorObjectDetail() Returns a handle for the ERROR-OBJECT-DETAIL attribute, set in cases of SOAP-related faults.
character	getErrorText(int index) Returns the Progress compatible error text associated with the error entry at the given index in the error list.
character	getErrorText(integer index) Returns the Progress compatible error text associated with the error entry at the given index in the error list.
integer	numErrors() Returns the number of the errors (recorded in the error list) which have occurred during the last call to ErrorManager.silent(java.lang.Runnable).
void	setNumErrors(int64 errCount) Undocumented feature encountered in customer code.

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Methods inherited from interface com.goldencode.p2j.util.Errorable

error, error, error

Methods inherited from interface com.goldencode.p2j.persist.ErrorString

changeErrorString, errorString

Method Detail

getErrorText

character getErrorText(integer index)

Returns the Progress compatible error text associated with the error entry at the given index in the error list. If the list is empty or if the index is invalid, an empty string "" is returned.

Parameters:

index - Position in the error list from which to return the entry.

Returns:

The error text at that index or the empty string "" if the list is empty or if the index is invalid.

getErrorText

character getErrorText(int index)

Returns the Progress compatible error text associated with the error entry at the given index in the error list. If the list is empty or if the index is invalid, an empty string "" is returned.

Parameters:

index - Position in the error list from which to return the entry.

Returns:

The error text at that index or the empty string "" if the list is empty or if the index is invalid.

numErrors

integer numErrors()

Returns the number of the errors (recorded in the error list) which have occurred during the last call to ErrorManager.silent(java.lang.Runnable).

Returns:

Current number of errors in the error list if silent mode has been enabled. This will be 0 if no errors have occurred since during the last silent mode call OR if silent mode has never been used.

setNumErrors

void setNumErrors(int64 errCount)

Undocumented feature encountered in customer code. After all, NUM-MESSAGES (KW_NUM_MSG) attribute seems to be writable.

Parameters:

errCount - New value.

getErrorNumber

integer getErrorNumber(integer index)

Returns the Progress compatible error number associated with the error entry at the given index in the error list. If the list is empty or if the index is invalid, 0 is returned.

Parameters:

index - Position in the error list from which to return the entry.

Returns:

The error number at that index or 0 if the list is empty or if the index is invalid.

getErrorNumber

integer getErrorNumber(int index)

Returns the Progress compatible error number associated with the error entry at the given index in the error list. If the list is empty or if the index is invalid, 0 is returned.

Parameters:

index - Position in the error list from which to return the entry.

Returns:

The error number at that index or 0 if the list is empty or if the index is invalid.

getErrorObjectDetail

handle getErrorObjectDetail()

Returns a handle for the ERROR-OBJECT-DETAIL attribute, set in cases of SOAP-related faults.

Returns:

See above.