IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.kernel.services
Interface ITestInfo


public interface ITestInfo

The ITestInfo interface provides information about the test that is currently executing.

ITestInfo is implemented by the object stored in the TestDataArea DataArea under the key TestInfo. This object is accessed from ICustomCode2 by calling ITestExecutionServices.findDataArea(IDataArea.TEST).get(ITestInfo.KEY)

See Also:
IDataArea, ITestExecutionServices

Field Summary
static String KEY
          Key for the ITestInfo object in the test's DataArea,
 
Method Summary
 String getName()
          Returns the name of the current test.
 int getPDLogLevel()
          Returns the Problem Determination Log level that is effective for the current test.
 int getTestLogLevel()
          Returns the TestLog level that is effective for all events for the current test.
 int getTestLogLevel(int filter)
          Returns the TestLog level for the given filter that is effective for the current test.
 int popPDLogLevel()
          Pops the Problem Determination Log level stack.
 int popTestLogLevel()
          Pops the stack for the TestLog level for all events.
 int popTestLogLevel(int filter)
          Pops the stack for the TestLog level for the given filter.
 void pushPDLogLevel(int level)
          Pushes the given Problem Determination Log level onto the test's stack.
 void pushTestLogLevel(int level)
          Pushes the given TestLog level for all events onto the test's stack.
 void pushTestLogLevel(int level, int filter)
          Pushes the given TestLog level for the given filter onto the test's stack.
 int setPDLogLevel(int level)
          Sets the Problem Determination Log level for the remainder of the current test to the given level.
 int setTestLogLevel(int level)
          Sets the TestLog level for all events for the remainder of the current test to the given level.
 int setTestLogLevel(int level, int filter)
          Sets the TestLog level for the given filter for the remainder of the current test to the given level.
 

Field Detail

KEY

static final String KEY
Key for the ITestInfo object in the test's DataArea,

See Also:
Constant Field Values
Method Detail

getName

String getName()
Returns the name of the current test.

Returns:
The name of the current test.

getPDLogLevel

int getPDLogLevel()
Returns the Problem Determination Log level that is effective for the current test.

Returns:
The Problem Determination Log level that is effective for the current test.

setPDLogLevel

int setPDLogLevel(int level)
Sets the Problem Determination Log level for the remainder of the current test to the given level.

The Problem Determination Log level is kept on a stack for the test. Setting the level is equivalent to popping the stack (if it is not empty) and pushing the new level.

Parameters:
level - The new Problem Determination Log level.
Returns:
The old Problem Determination Log level.
See Also:
ITestInfo.pushPDLogLevel(int), ITestInfo.popPDLogLevel()

pushPDLogLevel

void pushPDLogLevel(int level)
Pushes the given Problem Determination Log level onto the test's stack.

This changes the effective Problem Determination Log level for the remainder of the test.

Parameters:
level - The new Problem Determination Log level.
See Also:
ITestInfo.popPDLogLevel()

popPDLogLevel

int popPDLogLevel()
Pops the Problem Determination Log level stack.

This restores the effective Problem Determination Log level to its value before the last push.

Returns:
The popped level.
See Also:
ITestInfo.pushPDLogLevel(int)

getTestLogLevel

int getTestLogLevel()
Returns the TestLog level that is effective for all events for the current test.

Returns:
The TestLog level that is effective for the current test.

getTestLogLevel

int getTestLogLevel(int filter)
Returns the TestLog level for the given filter that is effective for the current test.

Parameters:
filter - The filter specifying the TestLog level to get.
Returns:
The TestLog level that is effective for the current test.

setTestLogLevel

int setTestLogLevel(int level)
Sets the TestLog level for all events for the remainder of the current test to the given level.

The TestLog level is kept on a stack for the test. Setting the level is equivalent to popping the stack (if it is not empty) and pushing the new level.

Parameters:
level - The new TestLog level.
Returns:
The old TestLog level.
See Also:
ITestInfo.pushTestLogLevel(int), ITestInfo.popTestLogLevel(int)

setTestLogLevel

int setTestLogLevel(int level,
                    int filter)
Sets the TestLog level for the given filter for the remainder of the current test to the given level.

The TestLog level is kept on a stack for the test. Setting the level is equivalent to popping the stack (if it is not empty) and pushing the new level.

Parameters:
level - The new TestLog level.
filter - The filter specifying the TestLog level to set.
Returns:
The old TestLog level.
See Also:
ITestInfo.pushTestLogLevel(int), ITestInfo.popTestLogLevel(int)

pushTestLogLevel

void pushTestLogLevel(int level)
Pushes the given TestLog level for all events onto the test's stack.

This changes the effective TestLog level for the remainder of the test.,/p>

Parameters:
level - The new TestLog level.
See Also:
ITestInfo.popTestLogLevel()

pushTestLogLevel

void pushTestLogLevel(int level,
                      int filter)
Pushes the given TestLog level for the given filter onto the test's stack.

This changes the effective TestLog level for the remainder of the test.,/p>

Parameters:
level - The new TestLog level.
filter - The filter specifying the TestLog level to push.
See Also:
ITestInfo.popTestLogLevel()

popTestLogLevel

int popTestLogLevel()
Pops the stack for the TestLog level for all events.

This restores the effective TestLog level to its value before the last push.

Returns:
The popped level.
See Also:
ITestInfo.pushTestLogLevel(int)

popTestLogLevel

int popTestLogLevel(int filter)
Pops the stack for the TestLog level for the given filter.

This restores the effective TestLog level to its value before the last push.

Parameters:
filter - The filter specifying the TestLog level to pop.
Returns:
The popped level.
See Also:
ITestInfo.pushTestLogLevel(int)

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.