|
IBM Rational Functional Tester Version 8.1.1000 IBM Rational Functional Tester API Reference Project Version 2.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
static final int LOW
static final int MEDIUM
static final int HIGH
static final int NO_DETAIL
static final int ACTION_DETAIL
static final int HIGHLEVEL_DETAIL
static final int VERBOSE_DETAIL
Method Detail |
---|
int getDetailLevel()
NO_DETAIL
,
ACTION_DETAIL
,
HIGHLEVEL_DETAIL
,
VERBOSE_DETAIL
void action(java.lang.String message)
message
- The action message to display.void highLevel(java.lang.String message)
message
- The high level message to display.void verbose(java.lang.String message)
message
- The verbose message to display.void checkCancel()
void setItemCount(int count, int level)
void beginTask(java.lang.String name, int totalWork)
name
- the name (or description) of the main tasktotalWork
- 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.void done()
boolean isCanceled()
true
if cancellation has been requested,
and false
otherwise#setCanceled
void subTask(java.lang.String name)
name
- the name (or description) of the subtaskvoid worked(int work)
work
- the number of work units just completed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |