com.goldencode.p2j.util

Interface ErrorWriter

All Known Implementing Classes:

ErrorWriterBatch, ErrorWriterInteractive, ErrorWriterServer

public interface ErrorWriter

Interface decribing the error messages outputs.

Method Summary

Modifier and Type	Method and Description
void	displayError(java.lang.String errmsg, boolean noMessageBox, java.lang.String[] stack, boolean logCallStack, boolean isFromLogManager) Displays error message using currently installed writer implementation.
void	displayErrorRedirected(java.lang.String errmsg, boolean logCallStack) Displays error message using currently installed writer implementation.
void	displayWarning(java.lang.String wrnmsg) Displays warning message using currently installed writer implementation.
boolean	isInBatchMode() Checks if the client is running in batch mode.
void	message(java.lang.String errmsg) Displays error message using currently installed writer implementation.
void	messageBox(java.lang.String masterMsg, java.lang.String title, boolean asInBatch) Displays error message box with title using currently installed writer implementation.
void	pause() Implements pause processing using currently installed writer implementation.
void	stopBatchSession() Stops the associated client session by generating UnstoppableExitException.

Method Detail

displayError

void displayError(java.lang.String errmsg,
                  boolean noMessageBox,
                  java.lang.String[] stack,
                  boolean logCallStack,
                  boolean isFromLogManager)

Displays error message using currently installed writer implementation.

Parameters:

errmsg - Text of the message to display.

noMessageBox - true if error is always displayed in message area or logged rather than displayed as a message box.

stack - Progress stack trace.

logCallStack - Add call stack to log. false when ALERT_BOX message.

isFromLogManager - Flag to indicate the error comes from LOG-MANAGER.

displayWarning

void displayWarning(java.lang.String wrnmsg)

Displays warning message using currently installed writer implementation.

Parameters:

wrnmsg - Text of the message to display.

displayErrorRedirected

void displayErrorRedirected(java.lang.String errmsg,
                            boolean logCallStack)

Displays error message using currently installed writer implementation. This is the redirected version of the displayError. If the output is redirected to file the message is writing to the file.

Parameters:

errmsg - Text of the message to display.

logCallStack - Add call stack to log. false when ALERT_BOX message.

isInBatchMode

boolean isInBatchMode()

Checks if the client is running in batch mode.

Returns:

true for batch mode, false otherwise.

message

void message(java.lang.String errmsg)

Displays error message using currently installed writer implementation.

Parameters:

errmsg - Text of the message to display.

messageBox

void messageBox(java.lang.String masterMsg,
                java.lang.String title,
                boolean asInBatch)

Displays error message box with title using currently installed writer implementation.

Parameters:

masterMsg - Text of the message to display.

title - The title for the message box to display.

asInBatch - treat redirected output like in batch mode (no dialogs)

pause

void pause()

Implements pause processing using currently installed writer implementation.

stopBatchSession

void stopBatchSession()

Stops the associated client session by generating UnstoppableExitException.