com.rational.test.ft.services
Interface ILog

All Superinterfaces:

ISimpleLog

All Known Implementing Classes:

ExecutionHistoryLog, HTMLLog, LogAdapter, LogExtensionAdapter, NullLog, TestScriptServicesLog, TextLog

public interface ILog
extends ISimpleLog

The log interface containing all log methods used by script playback.

Since:

RFT1.0

Field Summary

static java.lang.String	PROP_ACTUAL The property name to describe the actual data captured with a verification point.
static java.lang.String	PROP_ADDITIONAL_INFO The property name to describe a additional information.
static java.lang.String	PROP_APPLICATION The property name to describe an application name.
static java.lang.String	PROP_BASELINE The property name to describe the baseline data captured with a verification point.
static java.lang.String	PROP_BUFFERED_SNAPSHOT The property name that contains the value of the BufferedImage.
static java.lang.String	PROP_DATAPOOL_STORE Property to encapsulate datapool changes
static java.lang.String	PROP_ELAPSED_TIME The property name to describe a elapsed time.
static java.lang.String	PROP_EXCEPTION_CONTEXT The property name to describe an exception context.
static java.lang.String	PROP_EXCEPTION_MESSAGE The property name to describe an exception message.
static java.lang.String	PROP_EXCEPTION_NAME The property name to describe the name of an exception.
static java.lang.String	PROP_EXCEPTION_STACK The property name to describe an exception stack.
static java.lang.String	PROP_EXPECTED The property name to describe the expected data captured with a verification point.
static java.lang.String	PROP_FAILURE_DESCRIPTION The property name for additional text describing a warning/failure.
static java.lang.String	PROP_ITERATION_COUNT Property to set for the current script iteration count
static java.lang.String	PROP_LINENUMBER The property name to describe the line number in the script at which the error occured.
static java.lang.String	PROP_NAME The property name to describe an object name.
static java.lang.String	PROP_SCREEN_SNAPSHOT The property name to describe a screen snapshot.
static java.lang.String	PROP_SCRIPT_ID
static java.lang.String	PROP_SCRIPT_NAME The property name to describe a script name.
static java.lang.String	PROP_SCRIPT_SOURCE_UID Properties that are for Rational TestManager and that are only emitted when doing TSS logging.
static java.lang.String	PROP_SIMPLIFIEDSCRIPT_GRPNAME The property name to describe the group name in the simplified script(visual script).
static java.lang.String	PROP_SIMPLIFIEDSCRIPT_LINE The property name to describe the line of script in simplified script (visual script).
static java.lang.String	PROP_SIMPLIFIEDSCRIPT_LINENUMBER The property name to describe the line number in the simplified script(visual script).
static java.lang.String	PROP_TESTCASE_DESCRIPTION The property name to describe a test case description.
static java.lang.String	PROP_TESTCASE_NAME The property name to describe a test case name.
static java.lang.String	PROP_USER_SCREEN_SNAPSHOT The property name to describe a screen snapshot taken by a user (via logError, etc).
static java.lang.String	PROP_VP_TYPE The property name to describe a verification point type, for example, an object property.
static java.lang.String	SCREEN_SNAPSHOT_FILE_BASE
static java.lang.String	SCREEN_SNAPSHOT_FILE_EXT The snapshot file extension.
static java.lang.String	SCREEN_SNAPSHOT_FILE_NAME The file name of the snapshot taken at script failure
static java.lang.String	USER_SCREEN_SNAPSHOT_FILE_BASE The base file name (minus number) of snapshots logged by the user
static java.lang.String	VP_TYPE_ALPHA_NUM The property value to describe an alphanumeric verification point.
static java.lang.String	VP_TYPE_CLIPBOARD The property value to describe a clipboard verification point.
static java.lang.String	VP_TYPE_FILE_COMPARE The property value to describe a file-compare verification point.
static java.lang.String	VP_TYPE_FILE_EXIST The property value to describe a file-exist verification point.
static java.lang.String	VP_TYPE_FULL_IMAGE The property value to describe a full image verification point
static java.lang.String	VP_TYPE_MENU The property value to describe a menu verification point.
static java.lang.String	VP_TYPE_MODULE_EXIST The property value to describe a module existence verification point
static java.lang.String	VP_TYPE_OBJECT_DATA The property value to describe an object data verification point
static java.lang.String	VP_TYPE_OBJECT_PROP The property value to describe an object property verification point
static java.lang.String	VP_TYPE_OCR_IMAGE The property value to describe a region image verification point
static java.lang.String	VP_TYPE_REGION_IMAGE The property value to describe a region image verification point
static java.lang.String	VP_TYPE_WEBSITE_COMPARE The property value to describe a website compare verification point
static java.lang.String	VP_TYPE_WEBSITE_SCAN The property value to describe a website scan verification point
static java.lang.String	VP_TYPE_WINDOW_EXIST The property value to describe a window existence verification point
static java.lang.String	VP_TYPE_WINDOW_IMAGE The property value to describe a window image verification point

Fields inherited from interface com.rational.test.ft.services.ISimpleLog

DISABLE_LOGGING, EVENT_APPLICATION_END, EVENT_APPLICATION_START, EVENT_APPLICATON_ACTION, EVENT_CALL_SCRIPT, EVENT_CONFIGURATION, EVENT_GENERAL, EVENT_SCRIPT_END, EVENT_SCRIPT_START, EVENT_TIMER_END, EVENT_TIMER_START, EVENT_VP, LOG_DISABLE_GUI_ACTION, LOG_ENABLE_GUI_ACTION, LOG_FAILURE, LOG_FAILURES, LOG_FAILURES_WARNINGS, LOG_FAILURES_WARNINGS_PASS, LOG_FAILURES_WARNINGS_PASS_INFO, LOG_INFORMATION, LOG_PASS, LOG_WARNING

Method Summary

void	applicationStart(java.lang.String name, int status, java.lang.String description, java.lang.String language) Writes an application-start message into the log.
void	applicationStart(java.lang.String name, java.lang.String language) Writes an application-start message into the log.
void	callScript(java.lang.String name, java.lang.String language) Writes a calling-script message into the log.
void	configuration(java.lang.String language) Writes the system configuration into the log.
ILogMessage	createApplicationStartMessage(java.lang.String name, int status, java.lang.String description, java.lang.String language) Returns an application-start message.
ILogMessage	createConfigurationMessage(java.lang.String language) Creates a system configuration message.
ILogMessage	createGUIActionMessage(int resultCode, java.lang.String method, java.lang.String methodSignature, java.lang.Object[] args, java.lang.String testObjectRole, java.lang.String testObjectName) Creates a GUI Action message.
ILogMessage	createTestResultMessage(java.lang.String headline, boolean passed, java.lang.String additionalInfo) Creates a test result message.
ILogMessage	createTimerEndMessage(java.lang.String name, java.lang.String language) Returns an end-timer message.
ILogMessage	createTimerStartMessage(java.lang.String name, java.lang.String language) Returns a start-timer message.
ILogMessage	createVPMessage(int resultCode, java.lang.String type, java.lang.String name, java.lang.String language) Returns a verification point message.
void	exception(java.lang.String note, java.lang.String context, java.lang.String throwableName, java.lang.String throwableMessage, java.lang.String scriptName, int line, java.lang.String stackTrace, java.lang.String language) Writes an exception message.
void	exception(java.lang.String note, java.lang.String context, java.lang.String throwableName, java.lang.String throwableMessage, java.lang.String scriptName, int line, java.lang.String stackTrace, java.lang.String language, java.awt.image.BufferedImage screenSnapshot) Writes an exception message that includes a screen snapshot.
int	getCurrentLogFilter() Return the current log filter level.
boolean	getCurrentScriptResult() Returns the result of the current script.
boolean	getLastScriptResult() Returns the result of the last script that had ended.
java.lang.String	getLogDirectory() Returns the directory to which the log is being written.
java.lang.String	getLogFilename() Returns the name of the log filename including the file extension but no directory.
java.lang.String	getLogType() Return the type for the log
boolean	getTestResult() Returns the result of the current test.
double	getTimerAndEnd(java.lang.String name, java.lang.String language) Writes an end-timer message into the log and returns the value of the timer
double	getTimerValue(java.lang.String name) Writes a start-timer message into the log.
void	info(java.lang.String note) Writes a simple text informational message into the log.
boolean	isLogGuiActionEnabled(java.lang.String methodName) Returns true if Gui Actions are to be logged for the given method.
void	logRootException(java.lang.String scriptName, java.lang.String language, java.lang.String msg, java.lang.Throwable e, java.lang.String headline) The method can be used if failures occur prior to start of execution of script.
void	scriptEnd(java.lang.String name, java.lang.String language) Writes a script-end message into the log.
void	scriptStart(java.lang.String name, java.lang.String language) Writes a script-start message into the log.
void	setCurrentLogFilter(int filterLevel) Set the log filter for the playback.
void	setLogGUIAction(boolean logGuiAction) Sets the option to log the GUI Action during playback
void	timerEnd(java.lang.String name, java.lang.String language) Writes an end-timer message into the log.
void	timerStart(java.lang.String name, java.lang.String language) Writes a start-timer message into the log.
boolean	viewerKnowsHowToBringUpComparator() Answers yes or no to indicate whether the log viewer associated with this log knows how to bring up the comparator.
void	writeGUIAction(ILogMessage message) Writes an Gui Action message in the log

Methods inherited from interface com.rational.test.ft.services.ISimpleLog

close, createMessage, createMessage, open, openLogViewer, write, write

Field Detail

PROP_VP_TYPE

static final java.lang.String PROP_VP_TYPE

The property name to describe a verification point type, for example, an object property.

See Also:

Constant Field Values

PROP_ACTUAL

static final java.lang.String PROP_ACTUAL

The property name to describe the actual data captured with a verification point.

See Also:

Constant Field Values

PROP_EXPECTED

static final java.lang.String PROP_EXPECTED

The property name to describe the expected data captured with a verification point.

See Also:

Constant Field Values

PROP_BASELINE

static final java.lang.String PROP_BASELINE

The property name to describe the baseline data captured with a verification point.

See Also:

Constant Field Values

PROP_APPLICATION

static final java.lang.String PROP_APPLICATION

The property name to describe an application name.

See Also:

Constant Field Values

PROP_EXCEPTION_NAME

static final java.lang.String PROP_EXCEPTION_NAME

The property name to describe the name of an exception.

See Also:

Constant Field Values

PROP_EXCEPTION_MESSAGE

static final java.lang.String PROP_EXCEPTION_MESSAGE

The property name to describe an exception message.

See Also:

Constant Field Values

PROP_EXCEPTION_STACK

static final java.lang.String PROP_EXCEPTION_STACK

The property name to describe an exception stack.

See Also:

Constant Field Values

PROP_EXCEPTION_CONTEXT

static final java.lang.String PROP_EXCEPTION_CONTEXT

The property name to describe an exception context.

See Also:

Constant Field Values

PROP_SCREEN_SNAPSHOT

static final java.lang.String PROP_SCREEN_SNAPSHOT

The property name to describe a screen snapshot.

See Also:

Constant Field Values

PROP_USER_SCREEN_SNAPSHOT

static final java.lang.String PROP_USER_SCREEN_SNAPSHOT

The property name to describe a screen snapshot taken by a user (via logError, etc).

See Also:

Constant Field Values

PROP_LINENUMBER

static final java.lang.String PROP_LINENUMBER

The property name to describe the line number in the script at which the error occured.

See Also:

Constant Field Values

PROP_BUFFERED_SNAPSHOT

static final java.lang.String PROP_BUFFERED_SNAPSHOT

The property name that contains the value of the BufferedImage.

See Also:

Constant Field Values

PROP_SIMPLIFIEDSCRIPT_LINENUMBER

static final java.lang.String PROP_SIMPLIFIEDSCRIPT_LINENUMBER

The property name to describe the line number in the simplified script(visual script).

See Also:

Constant Field Values

PROP_SIMPLIFIEDSCRIPT_GRPNAME

static final java.lang.String PROP_SIMPLIFIEDSCRIPT_GRPNAME

The property name to describe the group name in the simplified script(visual script).

See Also:

Constant Field Values

PROP_SIMPLIFIEDSCRIPT_LINE

static final java.lang.String PROP_SIMPLIFIEDSCRIPT_LINE

The property name to describe the line of script in simplified script (visual script).

See Also:

Constant Field Values

PROP_SCRIPT_NAME

static final java.lang.String PROP_SCRIPT_NAME

The property name to describe a script name.

See Also:

Constant Field Values

PROP_NAME

static final java.lang.String PROP_NAME

The property name to describe an object name.

See Also:

Constant Field Values

PROP_TESTCASE_NAME

static final java.lang.String PROP_TESTCASE_NAME

The property name to describe a test case name.

See Also:

Constant Field Values

PROP_TESTCASE_DESCRIPTION

static final java.lang.String PROP_TESTCASE_DESCRIPTION

The property name to describe a test case description.

See Also:

Constant Field Values

PROP_ADDITIONAL_INFO

static final java.lang.String PROP_ADDITIONAL_INFO

The property name to describe a additional information.

See Also:

Constant Field Values

PROP_ELAPSED_TIME

static final java.lang.String PROP_ELAPSED_TIME

The property name to describe a elapsed time.

See Also:

Constant Field Values

PROP_FAILURE_DESCRIPTION

static final java.lang.String PROP_FAILURE_DESCRIPTION

The property name for additional text describing a warning/failure.

See Also:

Constant Field Values

PROP_SCRIPT_SOURCE_UID

static final java.lang.String PROP_SCRIPT_SOURCE_UID

Properties that are for Rational TestManager and that are only emitted when doing TSS logging.

See Also:

Constant Field Values

PROP_SCRIPT_ID

static final java.lang.String PROP_SCRIPT_ID

See Also:

Constant Field Values

PROP_DATAPOOL_STORE

static final java.lang.String PROP_DATAPOOL_STORE

Property to encapsulate datapool changes

See Also:

Constant Field Values

PROP_ITERATION_COUNT

static final java.lang.String PROP_ITERATION_COUNT

Property to set for the current script iteration count

See Also:

Constant Field Values

VP_TYPE_ALPHA_NUM

static final java.lang.String VP_TYPE_ALPHA_NUM

The property value to describe an alphanumeric verification point.

See Also:

Constant Field Values

VP_TYPE_CLIPBOARD

static final java.lang.String VP_TYPE_CLIPBOARD

The property value to describe a clipboard verification point.

See Also:

Constant Field Values

VP_TYPE_FILE_COMPARE

static final java.lang.String VP_TYPE_FILE_COMPARE

The property value to describe a file-compare verification point.

See Also:

Constant Field Values

VP_TYPE_FILE_EXIST

static final java.lang.String VP_TYPE_FILE_EXIST

The property value to describe a file-exist verification point.

See Also:

Constant Field Values

VP_TYPE_MENU

static final java.lang.String VP_TYPE_MENU

The property value to describe a menu verification point.

See Also:

Constant Field Values

VP_TYPE_MODULE_EXIST

static final java.lang.String VP_TYPE_MODULE_EXIST

The property value to describe a module existence verification point

See Also:

Constant Field Values

VP_TYPE_OBJECT_DATA

static final java.lang.String VP_TYPE_OBJECT_DATA

The property value to describe an object data verification point

See Also:

Constant Field Values

VP_TYPE_OBJECT_PROP

static final java.lang.String VP_TYPE_OBJECT_PROP

The property value to describe an object property verification point

See Also:

Constant Field Values

VP_TYPE_FULL_IMAGE

static final java.lang.String VP_TYPE_FULL_IMAGE

The property value to describe a full image verification point

See Also:

Constant Field Values

VP_TYPE_OCR_IMAGE

static final java.lang.String VP_TYPE_OCR_IMAGE

The property value to describe a region image verification point

See Also:

Constant Field Values

VP_TYPE_REGION_IMAGE

static final java.lang.String VP_TYPE_REGION_IMAGE

The property value to describe a region image verification point

See Also:

Constant Field Values

VP_TYPE_WEBSITE_COMPARE

static final java.lang.String VP_TYPE_WEBSITE_COMPARE

The property value to describe a website compare verification point

See Also:

Constant Field Values

VP_TYPE_WEBSITE_SCAN

static final java.lang.String VP_TYPE_WEBSITE_SCAN

The property value to describe a website scan verification point

See Also:

Constant Field Values

VP_TYPE_WINDOW_EXIST

static final java.lang.String VP_TYPE_WINDOW_EXIST

The property value to describe a window existence verification point

See Also:

Constant Field Values

VP_TYPE_WINDOW_IMAGE

static final java.lang.String VP_TYPE_WINDOW_IMAGE

The property value to describe a window image verification point

See Also:

Constant Field Values

SCREEN_SNAPSHOT_FILE_NAME

static final java.lang.String SCREEN_SNAPSHOT_FILE_NAME

The file name of the snapshot taken at script failure

See Also:

Constant Field Values

SCREEN_SNAPSHOT_FILE_BASE

static final java.lang.String SCREEN_SNAPSHOT_FILE_BASE

See Also:

Constant Field Values

USER_SCREEN_SNAPSHOT_FILE_BASE

static final java.lang.String USER_SCREEN_SNAPSHOT_FILE_BASE

The base file name (minus number) of snapshots logged by the user

See Also:

Constant Field Values

SCREEN_SNAPSHOT_FILE_EXT

static final java.lang.String SCREEN_SNAPSHOT_FILE_EXT

The snapshot file extension.

See Also:

Constant Field Values

Method Detail

getLogDirectory

java.lang.String getLogDirectory()

Returns the directory to which the log is being written. This is used by the verification point code to decide where to write expected or actual files. The issues of where the log is written to and where verification-point files should be written will be determined at some later time. The LogAdapter base class returns null for this; therefore, derived classes should override the method with a real answer. The verification-point logic handles null and writes the expected or actual results to the datastore directory in that case.

Since:

RFT1.0

getLogFilename

java.lang.String getLogFilename()

Returns the name of the log filename including the file extension but no directory.

Since:

RFT2.0

info

void info(java.lang.String note)

Writes a simple text informational message into the log.

Parameters:

note - The note to write to the log

Since:

RFT1.0

scriptStart

void scriptStart(java.lang.String name,                  java.lang.String language)

Writes a script-start message into the log.

Parameters:

name - The script name

language - The language used for the script ( i.e. java )

Since:

RFT1.0

scriptEnd

void scriptEnd(java.lang.String name,                java.lang.String language)

Writes a script-end message into the log.

Parameters:

name - The script name

language - The language used for the script ( i.e. java )

Since:

RFT1.0

callScript

void callScript(java.lang.String name,                 java.lang.String language)

Writes a calling-script message into the log.

Parameters:

name - The script being called

language - The language used for the script ( i.e. java )

Since:

RFT1.0

applicationStart

void applicationStart(java.lang.String name,                       java.lang.String language)

Writes an application-start message into the log.

Parameters:

name - The application's name

language - The language used for the script ( i.e. java )

Since:

RFT1.0

applicationStart

void applicationStart(java.lang.String name,                       int status,                       java.lang.String description,                       java.lang.String language)

Writes an application-start message into the log.

Parameters:

name - The application's name

status - Result of starting the application (@see ISimpleLog.LOG_FAILURE

description - Additional text for the status (e.g. reason for failure)

language - The language used for the script ( i.e. java )

Since:

RFT1.0

See Also:

ISimpleLog.LOG_WARNING, ISimpleLog.LOG_INFORMATION

createApplicationStartMessage

ILogMessage createApplicationStartMessage(java.lang.String name,                                           int status,                                           java.lang.String description,                                           java.lang.String language)

Returns an application-start message. This interface allows the caller to add detailed information and then write the message.

Parameters:

name - The application's name

status - Result of starting the application (@see ISimpleLog.LOG_FAILURE

description - Additional text for the status (e.g. reason for failure)

language - The language used for the script ( i.e. java )

Since:

RFT1.0

See Also:

ISimpleLog.LOG_WARNING, ISimpleLog.LOG_INFORMATION

timerStart

void timerStart(java.lang.String name,                 java.lang.String language)

Writes a start-timer message into the log.

Parameters:

name - The timer name

language - The language used for the script ( i.e. java )

Since:

RFT1.0

getTimerValue

double getTimerValue(java.lang.String name)

Writes a start-timer message into the log.

Parameters:

name - The timer name

language - The language used for the script ( i.e. java )

Since:

RFT8.1.0.1

createTimerStartMessage

ILogMessage createTimerStartMessage(java.lang.String name,                                     java.lang.String language)

Returns a start-timer message. This interface allows the caller to add detailed information and then write the message.

Parameters:

name - The timer name

language - The language used for the script ( i.e. java )

Since:

RFT1.0

timerEnd

void timerEnd(java.lang.String name,               java.lang.String language)

Writes an end-timer message into the log.

Parameters:

name - The timer name

language - The language used for the script ( i.e. java )

Since:

RFT1.0

getTimerAndEnd

double getTimerAndEnd(java.lang.String name,                       java.lang.String language)

Writes an end-timer message into the log and returns the value of the timer

Parameters:

name - The timer name

language - The language used for the script ( i.e. java )

Returns:

timer value The timer value

Since:

RFT8.1.0.1

createTimerEndMessage

ILogMessage createTimerEndMessage(java.lang.String name,                                   java.lang.String language)

Returns an end-timer message. This interface allows the caller to add detailed information and then write the message.

Parameters:

name - The timer name

language - The language used for the script ( i.e. java )

Returns:

A timer end message. This message has the result, event, and note initialized.

Since:

RFT1.0

createVPMessage

ILogMessage createVPMessage(int resultCode,                             java.lang.String type,                             java.lang.String name,                             java.lang.String language)

Returns a verification point message. This method allows the caller to add detailed information and then write the message.

Parameters:

resultCode - One of the LOG_ codes

type - One of the VP_TYPE_ codes

name - The verification point name

language - The language used for the script ( i.e. java )

Returns:

A verification point message. This message has the result, event, and note initialized.

Since:

RFT1.0

configuration

void configuration(java.lang.String language)

Writes the system configuration into the log. This method reads information from the test system utility and logs it.

Parameters:

language - The language used for the script ( i.e. java )

Since:

RFT1.0

createConfigurationMessage

ILogMessage createConfigurationMessage(java.lang.String language)

Creates a system configuration message. This method allows the caller to add detailed information and then write the message.

Parameters:

language - The language used for the script ( i.e. java )

Returns:

A configuration message. This message has the result, event, and note initialized.

Since:

RFT1.0

writeGUIAction

void writeGUIAction(ILogMessage message)

Writes an Gui Action message in the log

Parameters:

message - The Gui Action Message

createGUIActionMessage

ILogMessage createGUIActionMessage(int resultCode,                                    java.lang.String method,                                    java.lang.String methodSignature,                                    java.lang.Object[] args,                                    java.lang.String testObjectRole,                                    java.lang.String testObjectName)

Creates a GUI Action message. This method allows the caller to add detailed information and then write the message.

Parameters:

resultCode - The Result code PASS/FAILURE/WARNING/INFOMATION

method - The method that is getting called in the AUT

methodSignature - The signature of the method

args - The arguments passed to the method

testObjectRole - The role of the test object

testObjectName - The test object name

Returns:

exception

void exception(java.lang.String note,                java.lang.String context,                java.lang.String throwableName,                java.lang.String throwableMessage,                java.lang.String scriptName,                int line,                java.lang.String stackTrace,                java.lang.String language)

Writes an exception message.

Since:

RFT1.0

exception

void exception(java.lang.String note,                java.lang.String context,                java.lang.String throwableName,                java.lang.String throwableMessage,                java.lang.String scriptName,                int line,                java.lang.String stackTrace,                java.lang.String language,                java.awt.image.BufferedImage screenSnapshot)

Writes an exception message that includes a screen snapshot.

Since:

RFT2.1

createTestResultMessage

ILogMessage createTestResultMessage(java.lang.String headline,                                     boolean passed,                                     java.lang.String additionalInfo)

Creates a test result message.

Parameters:

headline - The headline of the test

passed - A boolean indicating whether the test passed or failed

additionalInfo - Additional information about the test

language - The language used for the script ( i.e. java )

Since:

RFT1.0

viewerKnowsHowToBringUpComparator

boolean viewerKnowsHowToBringUpComparator()

Answers yes or no to indicate whether the log viewer associated with this log knows how to bring up the comparator. The answer is true for the TSS log and false otherwise. This is used to decide whether to do a BringUpComparator after playback.

getCurrentScriptResult

boolean getCurrentScriptResult()

Returns the result of the current script. It returns false if there is any failure and true if there are no failures. The result includes the result of the scripts that this script had called.

Returns:

boolean

Since:

RFT 7.0.1

getLastScriptResult

boolean getLastScriptResult()

Returns the result of the last script that had ended. It returns false if there is any failure and true if there are no failures. The result includes the result of the scripts that the last script had called. It returns true if no script had ended.

Returns:

boolean

Since:

RFT 7.0.1

getTestResult

boolean getTestResult()

Returns the result of the current test. It returns false if there is any failure and true if there are no failures. The result includes the result of all the scripts that are executed in the current run.

Returns:

boolean

Since:

RFT 7.0.1

getCurrentLogFilter

int getCurrentLogFilter()

Return the current log filter level.

Returns:

int The filter level DISABLE_LOGGING The filter level for logging to disable all logging LOG_FAILURES The filter level for logging to log all failures. LOG_FAILURES_WARNINGS The filter level for logging to log all failures and warnings LOG_FAILURES_WARNINGS_PASS The filter level for logging to log all failures, warnings and pass results LOG_FAILURES_WARNINGS_PASS_INFO The filter level for logging to log all. LOG_ENABLE_GUI_ACTION The filter level to log all GUI actions. LOG_DISABLE_GUI_ACTION The filter level to disable logging of all GUI Actions.

setCurrentLogFilter

void setCurrentLogFilter(int filterLevel)

Set the log filter for the playback. If invalid values are given, then the default setting is used

Parameters:

filterLevel - DISABLE_LOGGING The filter level for logging to disable all logging LOG_FAILURES The filter level for logging to log all failures. LOG_FAILURES_WARNINGS The filter level for logging to log all failures and warnings LOG_FAILURES_WARNINGS_PASS The filter level for logging to log all failures, warnings and pass results LOG_FAILURES_WARNINGS_PASS_INFO The filter level for logging to log all. LOG_ENABLE_GUI_ACTION The filter level to log all GUI actions. LOG_DISABLE_GUI_ACTION The filter level to disable logging of all GUI Actions.

isLogGuiActionEnabled

boolean isLogGuiActionEnabled(java.lang.String methodName)

Returns true if Gui Actions are to be logged for the given method.

Returns:

true if GUI Actions are to be logged for the given method.

setLogGUIAction

void setLogGUIAction(boolean logGuiAction)

Sets the option to log the GUI Action during playback

Parameters:

logGuiAction - true if the Gui Action is to be logged

logRootException

void logRootException(java.lang.String scriptName,                       java.lang.String language,                       java.lang.String msg,                       java.lang.Throwable e,                       java.lang.String headline)

The method can be used if failures occur prior to start of execution of script.

Parameters:

scriptName - The script name

language - The language used

msg - The localized message

e - The Throwable object

getLogType

java.lang.String getLogType()

Return the type for the log

Returns:

one of the FtCommand.LOG_FORMAT_HTML, FtCommand.LOG_FORMAT_TPTP, FtCommand.LOG_FORMAT_TEXT, ...