intarsys runtime library

de.intarsys.tools.reporter
Interface IReporter

All Known Implementing Classes:
DefaultReporter, NullReporter, ReplayReporter, ReportDispatcher

public interface IReporter

An interface to report different types of information to the user.

This may be implemented for example as pure logging in a headless environment or with message dialogs in a window system.


Field Summary
static int STYLE_BEEP
           
static int STYLE_NONE
           
static int STYLE_STANDALONE
           
 
Method Summary
 void reportActivityEnd()
          Indicate the end of an activity.
 void reportActivityStart(String message, int style)
          Indicate the beginning of an activity, possibly blocking system interaction.
 void reportError(String title, String message, Throwable t, int style)
          Indicate an error condition.
 void reportMessage(String title, String message, int style)
          Report a message to the user.
 void reportProgress(String message, int percent, int style)
          Indicate the progress of an ongoing activity.
 void reportStatus(String message, int style)
          Report a simple state information.
 

Field Detail

STYLE_NONE

static final int STYLE_NONE
See Also:
Constant Field Values

STYLE_STANDALONE

static final int STYLE_STANDALONE
See Also:
Constant Field Values

STYLE_BEEP

static final int STYLE_BEEP
See Also:
Constant Field Values
Method Detail

reportActivityEnd

void reportActivityEnd()
Indicate the end of an activity.


reportActivityStart

void reportActivityStart(String message,
                         int style)
Indicate the beginning of an activity, possibly blocking system interaction.

Parameters:
message - A label for reporting the activity.
style -

reportError

void reportError(String title,
                 String message,
                 Throwable t,
                 int style)
Indicate an error condition. This method will return normally after a possible user interaction, any error handling is still up to the caller.

Parameters:
title -
message -
t -
style -

reportMessage

void reportMessage(String title,
                   String message,
                   int style)
Report a message to the user. The message should be displayed in a blocking way in an interactive system.

Parameters:
title -
message -
style -

reportProgress

void reportProgress(String message,
                    int percent,
                    int style)
Indicate the progress of an ongoing activity. The activity will probably run concurrently.

Parameters:
message -
percent -
style -

reportStatus

void reportStatus(String message,
                  int style)
Report a simple state information. This should not block the system in any way.

Parameters:
message -
style -

intarsys runtime library

Copyright © 2008 intarsys consulting GmbH. All Rights Reserved.