com.rational.test.ft.script
Interface IObjectManagerEventListener

All Known Implementing Classes:

RationalTestScript

public interface IObjectManagerEventListener

Used by RationalTestScript for notification of events by the object manager. The object manager is responsible for finding objects in the software under test and then for invoking methods on the found object.

Since:

RFT1.0

Method Summary

void	onAmbiguousRecognition(ITestObjectMethodState testObjectMethodState, TestObject[] choices, int[] scores) Called by the object manager when more than one object matching the specified pattern is found.
void	onObjectNotFound(ITestObjectMethodState testObjectMethodState) Called by the object manager when an object cannot be found.
void	onRecognitionWarning(ITestObjectMethodState testObjectMethodState, TestObject foundObject, int score) Called by the object manager when an object is found but the recognition score is above the warning threshold (rt.recognition_threshold_warning).
void	onSubitemNotFound(ITestObjectMethodState testObjectMethodState, TestObject foundObject, java.lang.String subitemDescription) Called by the object manager when a subitem cannot be found.
void	onTestObjectMethodException(ITestObjectMethodState testObjectMethodState, TestObject foundObject) Called by the object manager when a script command throws an exception.
void	onVpFailure(IFtVerificationPoint vp) Called by the IFtVerificationPoint implementation when the specified verification point fails to compare successfully.

Method Detail

onObjectNotFound

void onObjectNotFound(ITestObjectMethodState testObjectMethodState)

Called by the object manager when an object cannot be found.

Parameters:

testObjectMethodState - the state of the TestObject method

Since:

RFT1.0

See Also:

ITestObjectMethodState

onAmbiguousRecognition

void onAmbiguousRecognition(ITestObjectMethodState testObjectMethodState,                             TestObject[] choices,                             int[] scores)

Called by the object manager when more than one object matching the specified pattern is found.

Parameters:

testObjectMethodState - the state of the TestObject method

choices - an array of the ambiguous objects. These are always found objects, and they are therefore suitable for use with ITestObjectMethodState.setFoundTestObject.

scores - an array of the recognition scores. A score of zero is a good score, and higher numbers are bad scores. (Negative values are not used).

Since:

RFT1.0

See Also:

ITestObjectMethodState

onSubitemNotFound

void onSubitemNotFound(ITestObjectMethodState testObjectMethodState,                        TestObject foundObject,                        java.lang.String subitemDescription)

Called by the object manager when a subitem cannot be found.

Parameters:

testObjectMethodState - the state of the TestObject method

foundObject - the object used in the method invocation when the exception occurred

subitemDescription - the description of the subitem (from the SubitemNotFoundException)

Since:

RFT1.0

See Also:

ITestObjectMethodState

onTestObjectMethodException

void onTestObjectMethodException(ITestObjectMethodState testObjectMethodState,                                  TestObject foundObject)

Called by the object manager when a script command throws an exception.

Parameters:

testObjectMethodState - the state of the TestObject method

foundObject - The object used in the method invocation when the exception occurred
Note that the found object whose method was invoked may be gone. In this case, >foundObject is null.

Since:

RFT1.0

See Also:

ITestObjectMethodState

onRecognitionWarning

void onRecognitionWarning(ITestObjectMethodState testObjectMethodState,                           TestObject foundObject,                           int score)

Called by the object manager when an object is found but the recognition score is above the warning threshold (rt.recognition_threshold_warning).

Parameters:

testObjectMethodState - the state of the TestObject method

foundObject - the object to be used if an exception occurs

score - the numeric score

Since:

RFT1.0

See Also:

ITestObjectMethodState

onVpFailure

void onVpFailure(IFtVerificationPoint vp)

Called by the IFtVerificationPoint implementation when the specified verification point fails to compare successfully. The default implementation of this event handler performs no actions. A user may choose to override the default implementation and throw an exception to terminate script execution on verification-point failure.

Parameters:

vp - the verification-point object that failed to compare successfully

Since:

RFT1.0