com.goldencode.p2j.util

Class ErrorManager.ErrorHelper

java.lang.Object

com.goldencode.p2j.util.ErrorManager.ErrorHelper

Enclosing class:

ErrorManager

public static class ErrorManager.ErrorHelper
extends java.lang.Object

Helper to expose error state in a way that avoids context local lookups.

Field Summary

Fields

Modifier and Type	Field and Description
private ErrorManager.ServerErrorDataAccessor	srv Server-side error methods.
private ErrorManager.WorkArea	wa Context-local error state.

Constructor Summary

Constructors

Constructor and Description
ErrorHelper(ErrorManager.WorkArea wa, ErrorManager.ServerErrorDataAccessor srv) Create a new instance and associate the given WorkArea instance.

Method Summary

Modifier and Type	Method and Description
void	addError(int num, java.lang.String text, boolean errFlag, boolean prefix) Adds an error entry to the error list.
void	addNumbersToConditionException(ConditionException e) Adds error numbers to raised error numbers stack
void	clearPending() Clears pending error status.
boolean	getErrorStatus() Retrieves the ERROR-STATUS:ERROR of the current WorkArea.
java.lang.String	getSuppressWarningsList() Reflects the value of SESSION:SUPPRESS-WARNINGS-LIST attribute.
void	handleForwardPending() Handles the change of the pending error status, making it into the current error status.
void	ignore(java.lang.Runnable code) Execute the given block while supressing normal error processing by temporarily enabling the ignore flag.
boolean	isHeadless() Determines if headless mode should be supported.
boolean	isInCanFindBracket() Detects if the temporary CAN-FIND headless mode is active.
boolean	isPending() Queries the state of pendingError variable.
boolean	isSilent() Reports on the context-local silent flag.
boolean	isSuppressWarnings() Reflects the value of SESSION:SUPPRESS-WARNINGS attribute.
boolean	isWarningMode() Reports if warning mode has been enabled.
boolean	nestedSilent(java.lang.Runnable code, java.util.function.BiConsumer<java.lang.String,java.lang.Integer> errorProcessor) Worker method that executes a given block of code with silent error mode turned on for the duration of the code block.
void	noRecordOrThrowError(java.lang.String msg) Throws an ErrorConditionException and if in silent mode, it sets the pending flag to true.
void	setCanFindBracket(boolean enter) Sets silent mode during CAN-FIND calls.
void	setHeadless(boolean headless) Set the headless flag for this context.
void	setPending(boolean value) Sets the pendingError variable.
void	setSilent(boolean value) Sets the silent variable.
void	setWarningMode(boolean on) Configures warning mode, during which errors are non-fatal (when on is true), but are reported to the UI of the current context via a call to LogicalTerminal.message().
boolean	silent(java.lang.Runnable code) Worker method that executes a given block of code with silent error mode turned on for the duration of the code block.

Methods inherited from class java.lang.Object

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

Field Detail

wa

private ErrorManager.WorkArea wa

Context-local error state.

srv

private ErrorManager.ServerErrorDataAccessor srv

Server-side error methods.

Constructor Detail

ErrorHelper

public ErrorHelper(ErrorManager.WorkArea wa,
                   ErrorManager.ServerErrorDataAccessor srv)

Create a new instance and associate the given WorkArea instance.

Parameters:

wa - Context-local error state.

srv - Server-side error methods.

Method Detail

nestedSilent

public boolean nestedSilent(java.lang.Runnable code,
                            java.util.function.BiConsumer<java.lang.String,java.lang.Integer> errorProcessor)

Worker method that executes a given block of code with silent error mode turned on for the duration of the code block. Before the code block is executed, silent error mode is turned on and after the code block completes (normally or abnormally), silent error mode will be disabled.

This method can only be executed on the server side. It will backup and restore the current ErrorManager.WorkArea.errorStatus, to allow for nested silent-mode usages (internally by FWD).

Parameters:

code - The block of code to execute in silent mode.

errorProcessor - A consumer of the logged errors in silent mode.

Returns:

The value of the ERROR-STATUS:ERROR flag when the execution is complete.

isSuppressWarnings

public boolean isSuppressWarnings()

Reflects the value of SESSION:SUPPRESS-WARNINGS attribute.

Returns:

The suppress warnings flag.

getSuppressWarningsList

public java.lang.String getSuppressWarningsList()

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

Returns:

The suppress warnings list flag.

isSilent

public boolean isSilent()

Reports on the context-local silent flag.

Returns:

true if silent error mode is active.

setSilent

public void setSilent(boolean value)

Sets the silent variable.

Parameters:

value - The new state of the variable.

silent

public boolean silent(java.lang.Runnable code)

Worker method that executes a given block of code with silent error mode turned on for the duration of the code block. Before the code block is executed, silent error mode is turned on and after the code block completes (normally or abnormally), silent error mode will be disabled.

This method can only be executed on the server side.

Parameters:

code - The block of code to execute in silent mode.

Returns:

The value of the ERROR-STATUS:ERROR flag when the execution is complete.

isPending

public boolean isPending()

Queries the state of pendingError variable.

Returns:

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

setPending

public void setPending(boolean value)

Sets the pendingError variable.

Parameters:

value - The new state of the variable.

clearPending

public void clearPending()

Clears pending error status.

handleForwardPending

public void handleForwardPending()

Handles the change of the pending error status, making it into the current error status.

getErrorStatus

public boolean getErrorStatus()

Retrieves the ERROR-STATUS:ERROR of the current WorkArea.

Returns:

value of ERROR-STATUS:ERROR of the current WorkArea.

isHeadless

public boolean isHeadless()

Determines if headless mode should be supported. In headless mode, no client-side output will occur.

Returns:

true if the headless flag is turned on, otherwise false.

setHeadless

public void setHeadless(boolean headless)

Set the headless flag for this context.

Parameters:

headless - true if this context has no UI.

isInCanFindBracket

public boolean isInCanFindBracket()

Detects if the temporary CAN-FIND headless mode is active. This really should be something generic instead of being hard coded to the persistence package.

Returns:

true if this is a CAN-FIND bracket.

setCanFindBracket

public void setCanFindBracket(boolean enter)

Sets silent mode during CAN-FIND calls. The semaphore keep tracks of the nested CAN-FIND calls. If the counter is positive ErrorManager will run similar to headless mode and will silently discard error messages.

NoteAlways call this method in pairs (one with enter = true before executing the query and, one with enter = false, immediately after) to assure the correct management of the headless context flag.

Parameters:

enter - If true will increment the nested CAN-FIND count.

ignore

public void ignore(java.lang.Runnable code)

Execute the given block while supressing normal error processing by temporarily enabling the ignore flag.

Parameters:

code - The code to execute.

addNumbersToConditionException

public void addNumbersToConditionException(ConditionException e)

Adds error numbers to raised error numbers stack

Parameters:

e - The condition exception meant to be iterated for causes

addError

public void addError(int num,
                     java.lang.String text,
                     boolean errFlag,
                     boolean prefix)

Adds an error entry to the error list.

Parameters:

num - The error number.

text - The text of the error message.

errFlag - If false this should add the number and text to the error list but not set the error flag. If true the error flag should also be set.

prefix - true to prepend a double asterisk prefix to the formatted error message, false to omit this text.

noRecordOrThrowError

public void noRecordOrThrowError(java.lang.String msg)

Throws an ErrorConditionException and if in silent mode, it sets the pending flag to true. NO error information (messages or error numbers) will be recorded in either case (i.e. silent mode or not). In silent mode the ERROR-STATUS:ERROR will be true but the other "records" of the error that normally exist, will not exist. No message will be displayed. Because no message is ever displayed or recorded, the normal error number/message processing is not executed.

This only works on the server side.

Parameters:

msg - The text to use in throwing the error exception.

isWarningMode

public boolean isWarningMode()

Reports if warning mode has been enabled. When in warning mode, error messages are reported to the UI using an alert box.

Returns:

true if warning mode is enabled, otherwise false.

setWarningMode

public void setWarningMode(boolean on)

Configures warning mode, during which errors are non-fatal (when on is true), but are reported to the UI of the current context via a call to LogicalTerminal.message().

Each call to this method must be matched with a corresponding call to ErrorManager.warningModeDisable().

Parameters:

on - Pass true to enable reported but non-fatal errors, and false to handle errors normally.