com.arcway.cockpit.docgen.provider.interfaces

Interface ILogger

public interface ILogger

Logger.

Logging entries are shown in ARCWAY Cockpit's error view. Note: Velocity logging has to be enabled in the ARCWAY Cockpit properties dialog.

Method Summary

Modifier and Type	Method and Description
void	abort(java.lang.String message) Aborts the script.
void	checkForCancelation() Call this frequently to check if the user wants to cancel the report processing.
void	debug(java.lang.String message) Logs a message in debug level.
void	error(java.lang.String message) Logs a message in error level.
void	info(java.lang.String message) Logs a message in info level.
boolean	isDebugEnabled() Determines if debug leven is enabled.
void	reportProgress(java.lang.String message) Call this to inform the user about the current state of report processing.
void	warn(java.lang.String message) Logs a message in warning level.

Method Detail

error

void error(java.lang.String message)

Logs a message in error level.

Parameters:

message -

warn

void warn(java.lang.String message)

Logs a message in warning level.

Parameters:

message -

info

void info(java.lang.String message)

Logs a message in info level.

Parameters:

message -

isDebugEnabled

boolean isDebugEnabled()

Determines if debug leven is enabled.

Returns:

true if enabled

debug

void debug(java.lang.String message)

Logs a message in debug level. Note: Debug level is not available in ARCWAY Cockpit's error view.

Parameters:

message -

abort

void abort(java.lang.String message)

Aborts the script.

This method shows a rather technical error message.

Parameters:

message - a message that is displayed to the user

checkForCancelation

void checkForCancelation()
                  throws com.arcway.cockpit.docgen.writer.ReportGenerationCanceledException

Call this frequently to check if the user wants to cancel the report processing.

Throws:

com.arcway.cockpit.docgen.writer.ReportGenerationCanceledException

reportProgress

void reportProgress(java.lang.String message)
             throws com.arcway.cockpit.docgen.writer.ReportGenerationCanceledException

Call this to inform the user about the current state of report processing.

Parameters:

message -

Throws:

com.arcway.cockpit.docgen.writer.ReportGenerationCanceledException