com.rational.test.ft.services
Interface ISimpleLog

All Known Subinterfaces:

ILog

All Known Implementing Classes:

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

public interface ISimpleLog

The log interface containing the base-level log static values and methods.

Since:

RFT1.0

Field Summary

static int	DISABLE_LOGGING The filter level for logging to disable all logging
static int	EVENT_APPLICATION_END The event indicator for an application-end message.
static int	EVENT_APPLICATION_START The event indicator for an application-start message.
static int	EVENT_APPLICATON_ACTION The event indicator for an action performed on the application under test
static int	EVENT_CALL_SCRIPT The event indicator for a call-script message.
static int	EVENT_CONFIGURATION The event indicator for a configuration message.
static int	EVENT_GENERAL The event indicator for a general log message message.
static int	EVENT_SCRIPT_END The event indicator for a script-end message.
static int	EVENT_SCRIPT_START The event indicator for a script-start message.
static int	EVENT_TIMER_END The event indicator for a timer-end message.
static int	EVENT_TIMER_START The event indicator for a timer-start message.
static int	EVENT_VP The event indicator for a verification-point message.
static int	LOG_DISABLE_GUI_ACTION The filter level to disable logging of all GUI actions.
static int	LOG_ENABLE_GUI_ACTION The filter level to log all GUI actions.
static int	LOG_FAILURE The status indicator used to flag a failure message.
static int	LOG_FAILURES The filter level for logging to log all failures.
static int	LOG_FAILURES_WARNINGS The filter level for logging to log all failures and warnings
static int	LOG_FAILURES_WARNINGS_PASS The filter level for logging to log all failures, warnings and pass results
static int	LOG_FAILURES_WARNINGS_PASS_INFO The filter level for logging to log all.
static int	LOG_INFORMATION The status indicator used to flag an information message.
static int	LOG_PASS The status indicator used to flag a success message.
static int	LOG_WARNING The status indicator used to flag a warning message.

Method Summary

void	close() Closes the log, thereby releasing any resources.
ILogMessage	createMessage() Creates an instance of a log message.
ILogMessage	createMessage(int resultCode, int eventCode, java.lang.String headline) Creates an instance of a log message specifying the status, event, and note.
void	open() Opens the log.
boolean	openLogViewer() The function to open the viewer for the log.
void	write(ILogMessage message) Writes a message into the log.
void	write(int resultCode, int eventCode, java.lang.String note) Writes a simple message into the log file.

Field Detail

LOG_FAILURE

static final int LOG_FAILURE

The status indicator used to flag a failure message.

See Also:

Constant Field Values

LOG_WARNING

static final int LOG_WARNING

The status indicator used to flag a warning message.

See Also:

Constant Field Values

LOG_PASS

static final int LOG_PASS

The status indicator used to flag a success message.

See Also:

Constant Field Values

LOG_INFORMATION

static final int LOG_INFORMATION

The status indicator used to flag an information message.

See Also:

Constant Field Values

EVENT_SCRIPT_START

static final int EVENT_SCRIPT_START

The event indicator for a script-start message.

See Also:

Constant Field Values

EVENT_SCRIPT_END

static final int EVENT_SCRIPT_END

The event indicator for a script-end message.

See Also:

Constant Field Values

EVENT_VP

static final int EVENT_VP

The event indicator for a verification-point message.

See Also:

Constant Field Values

EVENT_CALL_SCRIPT

static final int EVENT_CALL_SCRIPT

The event indicator for a call-script message.

See Also:

Constant Field Values

EVENT_APPLICATION_START

static final int EVENT_APPLICATION_START

The event indicator for an application-start message.

See Also:

Constant Field Values

EVENT_APPLICATION_END

static final int EVENT_APPLICATION_END

The event indicator for an application-end message.

See Also:

Constant Field Values

EVENT_TIMER_START

static final int EVENT_TIMER_START

The event indicator for a timer-start message.

See Also:

Constant Field Values

EVENT_TIMER_END

static final int EVENT_TIMER_END

The event indicator for a timer-end message.

See Also:

Constant Field Values

EVENT_CONFIGURATION

static final int EVENT_CONFIGURATION

The event indicator for a configuration message.

See Also:

Constant Field Values

EVENT_GENERAL

static final int EVENT_GENERAL

The event indicator for a general log message message.

See Also:

Constant Field Values

EVENT_APPLICATON_ACTION

static final int EVENT_APPLICATON_ACTION

The event indicator for an action performed on the application under test

See Also:

Constant Field Values

DISABLE_LOGGING

static final int DISABLE_LOGGING

The filter level for logging to disable all logging

See Also:

Constant Field Values

LOG_FAILURES

static final int LOG_FAILURES

The filter level for logging to log all failures.

See Also:

Constant Field Values

LOG_FAILURES_WARNINGS

static final int LOG_FAILURES_WARNINGS

The filter level for logging to log all failures and warnings

See Also:

Constant Field Values

LOG_FAILURES_WARNINGS_PASS

static final int LOG_FAILURES_WARNINGS_PASS

The filter level for logging to log all failures, warnings and pass results

See Also:

Constant Field Values

LOG_FAILURES_WARNINGS_PASS_INFO

static final int LOG_FAILURES_WARNINGS_PASS_INFO

The filter level for logging to log all.

See Also:

Constant Field Values

LOG_ENABLE_GUI_ACTION

static final int LOG_ENABLE_GUI_ACTION

The filter level to log all GUI actions.

See Also:

Constant Field Values

LOG_DISABLE_GUI_ACTION

static final int LOG_DISABLE_GUI_ACTION

The filter level to disable logging of all GUI actions.

See Also:

Constant Field Values

Method Detail

open

void open()

Opens the log.

Since:

RFT1.0

close

void close()

Closes the log, thereby releasing any resources. Calls this when done with the log.

Since:

RFT1.0

write

void write(int resultCode,            int eventCode,            java.lang.String note)

Writes a simple message into the log file.

Parameters:

resultCode - One of the LOG_ codes

eventCode - One of the EVENT_ codes

note - Simple (one line) description of the message being specified

Since:

RFT1.0

See Also:

LOG_FAILURE, LOG_PASS, LOG_WARNING, LOG_INFORMATION, EVENT_SCRIPT_START, EVENT_SCRIPT_END, EVENT_VP, EVENT_CALL_SCRIPT, EVENT_APPLICATION_START, EVENT_APPLICATION_END, EVENT_TIMER_START, EVENT_TIMER_END, EVENT_CONFIGURATION, EVENT_GENERAL

write

void write(ILogMessage message)

Writes a message into the log. The ILogMessage enables more detailed information to be written into the log file (that is, name/value pairs).

Parameters:

message - The message (that is, resultCode, eventCode, note, and details)

Since:

RFT1.0

See Also:

LOG_FAILURE, LOG_PASS, LOG_WARNING, LOG_INFORMATION, EVENT_SCRIPT_START, EVENT_SCRIPT_END, EVENT_VP, EVENT_CALL_SCRIPT, EVENT_APPLICATION_START, EVENT_APPLICATION_END, EVENT_TIMER_START, EVENT_TIMER_END, EVENT_CONFIGURATION, EVENT_GENERAL

createMessage

ILogMessage createMessage()

Creates an instance of a log message. The ILogMessage enables more detailed information to be written to the log file (that is, name/value pairs)

Since:

RFT1.0

createMessage

ILogMessage createMessage(int resultCode,                           int eventCode,                           java.lang.String headline)

Creates an instance of a log message specifying the status, event, and note. The ILogMessage enables more detailed information to be written to the log file.

Parameters:

resultCode - One of the LOG_ codes

eventCode - One of the EVENT_ codes

headline - Simple (one line) description of the message being specified

Since:

RFT1.0

openLogViewer

boolean openLogViewer()

The function to open the viewer for the log. Overwrite to open the log at the end of the playback.

Returns:

true, on successfull opening of log viewer, false otherwise