Rational QualityArchitect/Java API
Version 1.0

com.rational.test.ct
Class TestLog

java.lang.Object
  |
  +--com.rational.test.tss.TSSBase
        |
        +--com.rational.test.tss.TSSLog
              |
              +--com.rational.test.ct.TestLog
All Implemented Interfaces:
com.rational.test.tss.TSSConstants

public class TestLog
extends com.rational.test.tss.TSSLog

This class lets you log information from test scripts and stubs.

The TestLog class extends the class com.rational.test.tss.TSSLog.


Fields inherited from interface com.rational.test.tss.TSSConstants
CTXT_datapoolDir, CTXT_END, CTXT_logData, CTXT_logDir, CTXT_logFile, CTXT_sourceUID, CTXT_style, CTXT_testScript, CTXT_testScriptSource, CTXT_timeZero, CTXT_todZero, CTXT_workingDir, EVAR_Delay_dly_scale, EVAR_END, EVAR_Initial_dly_max, EVAR_Log_level, EVAR_LogData_control, EVAR_LogEvent_control, EVAR_Record_level, EVAR_Suspend_check, EVAR_Think_avg, EVAR_Think_cpu_dly_scale, EVAR_Think_cpu_threshold, EVAR_Think_def, EVAR_Think_dist, EVAR_Think_dly_scale, EVAR_Think_max, EVAR_Think_sd, EVAR_TSS_disable, EVOP_END, EVOP_eval, EVOP_pop, EVOP_push, EVOP_reset, EVOP_restore, EVOP_save, EVOP_set, IV_alltext, IV_button_no, IV_cmd_id, IV_cmdcnt, IV_col, IV_column_headers, IV_command, IV_cursor_id, IV_END, IV_error, IV_error_logs, IV_error_text, IV_error_type, IV_fc_ts, IV_fcr_ts, IV_fcs_ts, IV_fr_ts, IV_fs_ts, IV_fuxe_ts, IV_host, IV_ig_eot_ts, IV_ig_fs_ts, IV_ig_ls_ts, IV_lc_ts, IV_lcr_ts, IV_lcs_ts, IV_lineno, IV_lr_ts, IV_ls_ts, IV_luxe_ts, IV_mcommand, IV_ncnull, IV_ncols, IV_ncrecv, IV_ncxmit, IV_nkxmit, IV_npixels_act, IV_npixels_diff, IV_npixels_exp, IV_nrecv, IV_nrows, IV_nusers, IV_nxmit, IV_prev_ig_fs_ts, IV_prev_ig_ls_ts, IV_refURI, IV_response, IV_row, IV_screen, IV_script, IV_source_file, IV_statement_id, IV_task_file, IV_total_nrecv, IV_total_response, IV_total_rows, IV_tux_tpurcode, IV_uid, IV_user_group, IV_uxe_cnt, IV_version, IV_xwin_diff_level, MST_BIND, MST_BUTTON, MST_CLEANUP, MST_CPUDLY, MST_DELAY, MST_DSPLYRESP, MST_EXITED, MST_EXITSQABASIC, MST_EXTERN_C, MST_FIND, MST_GETTASK, MST_HTTPCONN, MST_HTTPDISC, MST_IIOP_INVOKE, MST_INCL, MST_INIT, MST_INITTASK, MST_ITDLY, MST_MOTION, MST_PMATCH, MST_RECV_DELAY, MST_SATEXEC, MST_SEND, MST_SEND_DELAY, MST_SHVBLCK, MST_SHVREAD, MST_SHVWAIT, MST_SOCKCONN, MST_SOCKDISC, MST_SQABASIC_CODE, MST_SQLCONN, MST_SQLDISC, MST_SQLEXEC, MST_STARTAPP, MST_SUSPENDED, MST_TEST, MST_THINK, MST_TRN_PACING, MST_TUXEDO, MST_TYPE, MST_UNDEF, MST_USERCODE, MST_WAITOBJ, MST_WAITRESP, MST_WATCH, MST_XCLNTCONN, MST_XCLNTDISC, MST_XMOVEWIN, MST_XQUERY, MST_XSYNC, MST_XWINCMP, MST_XWINDUMP, N_MST_INCL, SHVADJ_none, SHVADJ_post_dec, SHVADJ_post_inc, SHVADJ_pre_dec, SHVADJ_pre_inc, SHVOP_add, SHVOP_and, SHVOP_assign, SHVOP_divide, SHVOP_modulo, SHVOP_multiply, SHVOP_or, SHVOP_shiftleft, SHVOP_shiftright, SHVOP_subtract, SHVOP_xor, TSS_ABORT, TSS_ATTACHED_LOG_FILE_PATH, TSS_CMD_STAT_FAIL, TSS_CMD_STAT_INFO, TSS_CMD_STAT_PASS, TSS_CMD_STAT_WARN, TSS_DP_NO_OPEN, TSS_DP_NOWRAP, TSS_DP_OPEN, TSS_DP_PERSIST, TSS_DP_PRIVATE, TSS_DP_RANDOM, TSS_DP_RANDOM_MASK, TSS_DP_REWIND, TSS_DP_SEQUENTIAL, TSS_DP_SHARED, TSS_DP_SHARED_MASK, TSS_DP_SHUFFLE, TSS_DP_WRAP, TSS_DP_WRAP_MASK, TSS_EOF, TSS_FAIL, TSS_INVALID, TSS_LOG_RESULT_COMPLETED, TSS_LOG_RESULT_FAIL, TSS_LOG_RESULT_INFO, TSS_LOG_RESULT_NONE, TSS_LOG_RESULT_NOT_RUN, TSS_LOG_RESULT_PASS, TSS_LOG_RESULT_STOPPED, TSS_LOG_RESULT_WARN, TSS_LOG_UNEVALUATED, TSS_NOOP, TSS_NOSERVER, TSS_NOTFOUND, TSS_OK, TSS_SOURCE_PATH, TSS_SYSERROR, TSS_TIMER_KEEP, TSS_TIMER_REMOVE
 
Constructor Summary
TestLog()
          Initializes the TestLog class.
 
Method Summary
static boolean writeException(java.lang.Throwable e)
          This method lets you log an exception that was thrown in a test script.
static void writeStubException(java.lang.String description, java.lang.Throwable e)
          This method lets you log information about an exception that was thrown during the execution of a Rational QualityArchitect stub.
static void writeStubMessage(java.lang.String message, java.lang.String description)
          This method lets you log a message relating to the execution of a stub.
static void writeVPLog(short result, java.lang.String VPName, java.lang.String description, java.lang.String additionalinfo, java.lang.String expectedfile, java.lang.String actualfile, java.lang.String baselinefile)
          Internal use only.
 
Methods inherited from class com.rational.test.tss.TSSLog
event, event, message, message, testCaseResult, testCaseResult
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TestLog

public TestLog()
Initializes the TestLog class.
Method Detail

writeException

public static boolean writeException(java.lang.Throwable e)
This method lets you log an exception that was thrown in a test script.
Parameters:
e - The exception to log.
Returns:
Returns true if the log attempt was successful, and false if the log attempt failed.

writeStubException

public static void writeStubException(java.lang.String description,
                                      java.lang.Throwable e)

This method lets you log information about an exception that was thrown during the execution of a Rational QualityArchitect stub.

Parameters:
description - A description of the exception. The description appears in the Description field of the Log Event Properties dialog box.
e - The exception to log.

writeStubMessage

public static void writeStubMessage(java.lang.String message,
                                    java.lang.String description)
This method lets you log a message relating to the execution of a stub.
Parameters:
message - The stub-related message to insert in the log. The message appears in the Log Event column of the LogViewer.
description - A description of the stub-related message. The description, which appears in the Description field of the Log Event Properties dialog box, lets you expand upon the logged message.

writeVPLog

public static void writeVPLog(short result,
                              java.lang.String VPName,
                              java.lang.String description,
                              java.lang.String additionalinfo,
                              java.lang.String expectedfile,
                              java.lang.String actualfile,
                              java.lang.String baselinefile)
                       throws java.lang.Exception
Internal use only.

30-Jun-2003

Rational QualityArchitect/Java Support Home Page
Copyright (c) 2000, Rational Software Corporation