org.LexGrid.LexBIG.Utility.logging
Interface LgMessageDirectorIF

All Known Subinterfaces:
CachingMessageDirectorIF, LgLoggerIF, StatusTrackingLogger
All Known Implementing Classes:
CachingMessageDirectorImpl, CommandLineMessageDirector, ExporterMessageDirector, Logger, MessageDirector, NullMessageDirector, SimpleLogger, SpringBatchMessageDirector

public interface LgMessageDirectorIF

Interface to help pass debug, error, and warning types of messages around from component to component.

Author:
Kevin Peterson , Daniel Armbrust

Method Summary
 void busy()
          Output to indicate system is busy - spin a cursor, print a dot, etc.
 java.lang.String debug(java.lang.String message)
          Take a debug message.
 java.lang.String error(java.lang.String message)
          Display a non-fatal error to the user.
 java.lang.String error(java.lang.String message, java.lang.Throwable sourceException)
          Display a non-fatal error to the user
 java.lang.String fatal(java.lang.String message)
          Display a fatal error to the user.
 java.lang.String fatal(java.lang.String message, java.lang.Throwable sourceException)
          Display a fatal error to the user.
 void fatalAndThrowException(java.lang.String message)
          Display a fatal error to the user - and then throw an exception.
 void fatalAndThrowException(java.lang.String message, java.lang.Throwable sourceException)
          Display a fatal error to the user - and then throw an exception.
 java.lang.String info(java.lang.String message)
          Displays a status type of message (not an error or a warning)
 java.lang.String warn(java.lang.String message)
          Display a warning to the user.
 java.lang.String warn(java.lang.String message, java.lang.Throwable sourceException)
          Display a warning to the user
 

Method Detail

busy

void busy()
Output to indicate system is busy - spin a cursor, print a dot, etc.


info

java.lang.String info(java.lang.String message)
Displays a status type of message (not an error or a warning)

Returns:
Implementations may return a string, such as a log id.

debug

java.lang.String debug(java.lang.String message)
Take a debug message.

Returns:
Implementations may return a string, such as a log id.

warn

java.lang.String warn(java.lang.String message)
Display a warning to the user.

Returns:
Implementations may return a string, such as a log id.

warn

java.lang.String warn(java.lang.String message,
                      java.lang.Throwable sourceException)
Display a warning to the user

Parameters:
sourceException - The source exception that caused the warning
Returns:
Implementations may return a string, such as a log id.

error

java.lang.String error(java.lang.String message)
Display a non-fatal error to the user.

Returns:
Implementations may return a string, such as a log id.

error

java.lang.String error(java.lang.String message,
                       java.lang.Throwable sourceException)
Display a non-fatal error to the user

Parameters:
sourceException - The source exception that caused the error.

fatal

java.lang.String fatal(java.lang.String message)
Display a fatal error to the user.

Returns:
Implementations may return a string, such as a log id.

fatal

java.lang.String fatal(java.lang.String message,
                       java.lang.Throwable sourceException)
Display a fatal error to the user.

Parameters:
sourceException - The source exception that caused the error.
Returns:
Implementations may return a string, such as a log id.

fatalAndThrowException

void fatalAndThrowException(java.lang.String message)
                            throws java.lang.Exception
Display a fatal error to the user - and then throw an exception.

Throws:
java.lang.Exception

fatalAndThrowException

void fatalAndThrowException(java.lang.String message,
                            java.lang.Throwable sourceException)
                            throws java.lang.Exception
Display a fatal error to the user - and then throw an exception.

Parameters:
sourceException - The source exception that caused the error.
Throws:
java.lang.Exception

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.