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

Project Version 2.3

com.rational.test.ft.services
Interface IPlaybackMonitor

All Known Implementing Classes:
PlaybackMonitor, PlaybackMonitorAdapter

public interface IPlaybackMonitor

The interface containing playback monitoring methods used during script playback.

There is a related interface IPlaybackMonitorDisplay that defines the display methods of a script playback monitor


Field Summary
static int LAST_STATE
          This is not a valid state.
static int LINE_NUM_UNKNOWN
          It is not known what line in the script is currently executing
static int RUNNING
          Running (i.e.
static int START_APP
          Starting an application
static int TYPING
          Doing key input
 
Method Summary
 java.lang.String getDescription()
          Get the description of the currently executing statement.
 boolean getDisplayLocked()
          Get the lock state of the monitor's display fields.
 void pause()
          Put the monitor UI in the "paused" state.
 void resetDescription()
          Reset to the base RUNNING state
 void resume()
          Resume the monitor UI from the paused state.
 void setDescription(int state, java.lang.String additionalText)
          Set the description of the currently executing statement
 void setDisplayLocked(boolean lockState)
          Lock (or unlock) the displayfields so the contents can not be changed.
 void setFinding(boolean state)
          Set whether currently trying to find an object
 void setScriptLine(int line)
          Set the line in the script currently executing
 void setScriptName(java.lang.String scriptName)
          Set the name of the script being played back
 void setVisible(boolean visible)
          Set the monitor to the said visible state
 void setWaiting(boolean state)
          Set whether the playback engine is waiting (e.g.
 void stop()
          Put the monitor UI in the "stopping" state.
 

Field Detail

LINE_NUM_UNKNOWN

static final int LINE_NUM_UNKNOWN
It is not known what line in the script is currently executing

See Also:
Constant Field Values

RUNNING

static final int RUNNING
Running (i.e. script is executing but we're not in any of the states below)

See Also:
Constant Field Values

TYPING

static final int TYPING
Doing key input

See Also:
Constant Field Values

START_APP

static final int START_APP
Starting an application

See Also:
Constant Field Values

LAST_STATE

static final int LAST_STATE
This is not a valid state. It is for internal use only!

Unfortunately interfaces cannot define protected or private values.

Keep this value up to date!

It is used for additional states which are defined in PlaybackMonitorAdapter.

See Also:
Constant Field Values
Method Detail

setScriptName

void setScriptName(java.lang.String scriptName)
Set the name of the script being played back

Parameters:
scriptName - The script name

setScriptLine

void setScriptLine(int line)
Set the line in the script currently executing

Parameters:
lineNum - The currently executing line number or (@link #LINE_NUM_UNKNOWN) if unknown

resetDescription

void resetDescription()
Reset to the base RUNNING state


setDescription

void setDescription(int state,
                    java.lang.String additionalText)
Set the description of the currently executing statement

Parameters:
state - The state (this selects a stock message) #RUNNING, @link #TYPING, @link #START_APP
additionalText - Additional text appended to the stock message.

getDescription

java.lang.String getDescription()
Get the description of the currently executing statement. If we already have a description, some lower-level code may skip setting a description.


setDisplayLocked

void setDisplayLocked(boolean lockState)
Lock (or unlock) the displayfields so the contents can not be changed. Useful for calling public api methods internally that update the description field (when you don't want it updated).

Parameters:
lockState - true to lock the display, false to unlock

getDisplayLocked

boolean getDisplayLocked()
Get the lock state of the monitor's display fields.


setFinding

void setFinding(boolean state)
Set whether currently trying to find an object

Parameters:
state - true - searching, false - not

setWaiting

void setWaiting(boolean state)
Set whether the playback engine is waiting (e.g. waiting before retrying an action)

Parameters:
state - true - waiting, false - not

pause

void pause()
Put the monitor UI in the "paused" state.


resume

void resume()
Resume the monitor UI from the paused state.


stop

void stop()
Put the monitor UI in the "stopping" state.


setVisible

void setVisible(boolean visible)
Set the monitor to the said visible state