com.goldencode.p2j.util

Interface RemoteErrorData

All Known Implementing Classes:

ErrorManager.ServerErrorDataAccessor, ErrorManager.SuppressedErrorDataAccessor

public interface RemoteErrorData

Describes methods available for the use in the ErrorManager to access the data residing on the server from both the server and client uniformly.

Author:

NVS

Method Summary

Modifier and Type	Method and Description
void	addRecord(java.lang.Object record) Adds a record to the list of error records.
java.lang.Object	getRecord(int index) Gets a record from the list of error records.
int	getSize() Gets the size of the list of error records.
java.lang.String	getSuppressWarningsList() Reflects the value of SESSION:SUPPRESS-WARNINGS-LIST attribute.
void	handleSoapFault(java.lang.String operationName, java.lang.String faultMsg, java.lang.String faultActor, java.lang.String faultCode, java.lang.String faultString, java.lang.String faultDetailXML) Handles a SOAP fault.
boolean	isErrorFlag() Queries the state of error variable.
boolean	isPending() Queries the state of pendingError variable.
boolean	isSilent() Queries the state of silent variable.
boolean	isSuppressWarnings() Reflects the value of SESSION:SUPPRESS-WARNINGS attribute.
boolean	isSystemAlertBoxes() Get the state of SESSION:SYSTEM-ALERT-BOXES attribute.
boolean	mustManageLegacyError() Check if the top-level block is ROUTINE-LEVEL UNDO, THROW or the current program is BLOCK-LEVEL UNDO, THROW.
boolean	mustThrowLegacyError() Check if the current ERROR condition must be raised as a legacy SysError.
void	recordForLegacyThrow(java.lang.String errmsg, int num) Record the specified error message and number, to be later thrown as a LegacyErrorException.
void	setPending(boolean value) Sets the pendingError variable.
void	setSilent(boolean value) Sets the silent variable.
void	throwErrorConditionException(int num, java.lang.String errmsg) Throw the specified error message and number.
void	writeLog(java.lang.String msg, boolean logCallStack, long threadId) Writes a log record.

Method Detail

isSilent

boolean isSilent()

Queries the state of silent variable.

Returns:

true if silent mode is enabled, otherwise false.

setSilent

void setSilent(boolean value)

Sets the silent variable.

Parameters:

value - The new state of the variable.

isErrorFlag

boolean isErrorFlag()

Queries the state of error variable.

Returns:

true if error flag is turned on, otherwise false.

isPending

boolean isPending()

Queries the state of pendingError variable.

Returns:

true if pending error flag is turned on, otherwise false.

setPending

void setPending(boolean value)

Sets the pendingError variable.

Parameters:

value - The new state of the variable.

getSize

int getSize()

Gets the size of the list of error records.

Returns:

The size of the list.

addRecord

void addRecord(java.lang.Object record)

Adds a record to the list of error records.

Parameters:

record - The object to add to the list of error records.

getRecord

java.lang.Object getRecord(int index)

Gets a record from the list of error records.

Parameters:

index - The record index.

Returns:

The object associated with the given index in the list.

isSuppressWarnings

boolean isSuppressWarnings()

Reflects the value of SESSION:SUPPRESS-WARNINGS attribute.

Returns:

see above.

getSuppressWarningsList

java.lang.String getSuppressWarningsList()

Reflects the value of SESSION:SUPPRESS-WARNINGS-LIST attribute.

Returns:

see above.

isSystemAlertBoxes

boolean isSystemAlertBoxes()

Get the state of SESSION:SYSTEM-ALERT-BOXES attribute.

Returns:

the state of SESSION:SYSTEM-ALERT-BOXES attribute.

mustManageLegacyError

boolean mustManageLegacyError()

Check if the top-level block is ROUTINE-LEVEL UNDO, THROW or the current program is BLOCK-LEVEL UNDO, THROW.

Returns:

see above.

mustThrowLegacyError

boolean mustThrowLegacyError()

Check if the current ERROR condition must be raised as a legacy SysError.

Returns:

see above.

recordForLegacyThrow

void recordForLegacyThrow(java.lang.String errmsg,
                          int num)

Record the specified error message and number, to be later thrown as a LegacyErrorException.

Parameters:

errmsg - The error message.

num - The error number.

throwErrorConditionException

void throwErrorConditionException(int num,
                                  java.lang.String errmsg)

Throw the specified error message and number.

Parameters:

num - The error number.

errmsg - The error message.

writeLog

void writeLog(java.lang.String msg,
              boolean logCallStack,
              long threadId)

Writes a log record.

Parameters:

msg - The log message.

logCallStack - Flag to indicate if call stack should be included in log.

threadId - The id of the thread recording the error message.

handleSoapFault

void handleSoapFault(java.lang.String operationName,
                     java.lang.String faultMsg,
                     java.lang.String faultActor,
                     java.lang.String faultCode,
                     java.lang.String faultString,
                     java.lang.String faultDetailXML)

Handles a SOAP fault.

Parameters:

operationName - The operation that failed.

faultMsg - The fault error msg.

faultActor - The fault actor.

faultCode - The fault code.

faultString - The fault string.

faultDetailXML - The fault details as xml.