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 java.lang.String KEY
          Key for the ITestInfo object in the test's DataArea,
 
Method Summary
 java.lang.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 the current test.
 int popPDLogLevel()
          Pops the Problem Determination Log level stack.
 int popTestLogLevel()
          Pops the TestLog level stack.
 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 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 the remainder of the current test to the given level.
 

Field Detail

KEY

public static final java.lang.String KEY
Key for the ITestInfo object in the test's DataArea,

See Also:
Constant Field Values
Method Detail

getName

public java.lang.String getName()
Returns the name of the current test.

Returns:
The name of the current test.

getPDLogLevel

public 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

public 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:
pushPDLogLevel(), popPDLogLevel()

pushPDLogLevel

public 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:
popPDLogLevel

popPDLogLevel

public 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:
pushPDLogLevel()

getTestLogLevel

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

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

setTestLogLevel

public int setTestLogLevel(int level)
Sets the TestLog level 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:
pushTestLogLevel(), popTestLogLevel()

pushTestLogLevel

public void pushTestLogLevel(int level)
Pushes the given TestLog level 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:
popTestLogLevel

popTestLogLevel

public int popTestLogLevel()
Pops the TestLog level stack.

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

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


Copyright (c) IBM Corp. and others 2005. All rights reserved