IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft.services
Interface IActionMonitor

All Known Implementing Classes:
NullActionMonitor

public interface IActionMonitor

Specifies the action monitor methods used to inform the user of actions being performed. The detail level of actions is controlled by the literals in this interface.


Field Summary
static int ACTION_DETAIL
          Used to specify that only action messages will be displayed.
static int HIGH
           
static int HIGHLEVEL_DETAIL
          Used to specify that action and high level messages will be displayed.
static int LOW
           
static int MEDIUM
           
static int NO_DETAIL
          Used to specify that no messages will be displayed.
static int VERBOSE_DETAIL
          Used to specify that all messages will be displayed.
 
Method Summary
 void action(java.lang.String message)
          Post an action message to the monitor.
 void beginTask(java.lang.String name, int totalWork)
          Notifies that the main task is beginning.
 void checkCancel()
           
 void done()
          Notifies that the work is done; that is, either the main task is completed or the user canceled it.
 int getDetailLevel()
          Suppling the detail level to the interface consumer is an optimization that allows the consumer to avoid generating potentially expensive messages that will not be utilized.
 void highLevel(java.lang.String message)
          Post a high level message to the monitor.
 boolean isCanceled()
          Returns whether cancelation of current operation has been requested.
 void setItemCount(int count, int level)
           
 void subTask(java.lang.String name)
          Notifies that a subtask of the main task is beginning.
 void verbose(java.lang.String message)
          Post a verbose message to the monitor.
 void worked(int work)
          Notifies that a given number of work unit of the main task has been completed.
 

Field Detail

LOW

static final int LOW
See Also:
Constant Field Values

MEDIUM

static final int MEDIUM
See Also:
Constant Field Values

HIGH

static final int HIGH
See Also:
Constant Field Values

NO_DETAIL

static final int NO_DETAIL
Used to specify that no messages will be displayed.

See Also:
Constant Field Values

ACTION_DETAIL

static final int ACTION_DETAIL
Used to specify that only action messages will be displayed.

See Also:
Constant Field Values

HIGHLEVEL_DETAIL

static final int HIGHLEVEL_DETAIL
Used to specify that action and high level messages will be displayed.

See Also:
Constant Field Values

VERBOSE_DETAIL

static final int VERBOSE_DETAIL
Used to specify that all messages will be displayed.

See Also:
Constant Field Values
Method Detail

getDetailLevel

int getDetailLevel()
Suppling the detail level to the interface consumer is an optimization that allows the consumer to avoid generating potentially expensive messages that will not be utilized. The result of this message is one of the DETAIL constants defined in this specification.

Returns:
One of the DETAIL literals.
See Also:
NO_DETAIL, ACTION_DETAIL, HIGHLEVEL_DETAIL, VERBOSE_DETAIL

action

void action(java.lang.String message)
Post an action message to the monitor.

Parameters:
message - The action message to display.

highLevel

void highLevel(java.lang.String message)
Post a high level message to the monitor. High level messages are generated for test asset and directory level actions.

Parameters:
message - The high level message to display.

verbose

void verbose(java.lang.String message)
Post a verbose message to the monitor. Verbose messages are generated for file level actions.

Parameters:
message - The verbose message to display.

checkCancel

void checkCancel()

setItemCount

void setItemCount(int count,
                  int level)

beginTask

void beginTask(java.lang.String name,
               int totalWork)
Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.

Parameters:
name - the name (or description) of the main task
totalWork - the total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implemenation is free to indicate progress in a way which doesn't require the total number of work units in advance.

done

void done()
Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).


isCanceled

boolean isCanceled()
Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

Returns:
true if cancellation has been requested, and false otherwise
See Also:
#setCanceled

subTask

void subTask(java.lang.String name)
Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.

Parameters:
name - the name (or description) of the subtask

worked

void worked(int work)
Notifies that a given number of work unit of the main task has been completed. Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.

Parameters:
work - the number of work units just completed