TestObject (DevOps Test UI)

java.lang.Object
- com.rational.test.ft.object.interfaces.TestObject

Direct Known Subclasses:

ClientTestObject, CrossDomainContainer, DomainTestObject, ProcessTestObject, SAPGuiApplicationTestObject, SAPGuiConnectionTestObject, SAPGuiSessionTestObject, TimeoutTestObject
```
public class TestObject
extends java.lang.Object
```
Provides access to objects in the software under test. A TestObject contains a reference to an object in the software under test, either referencing the object directly, or by using a reference to a MappedTestObject. The recognition algorithm is the work of the ObjectManager.

A TestObject is generally in a process separate from the software under test. If a method is called on such a TestObject and if the object returned by the method can be recreated in the process of the script, the object is considered a value class. If the object returned by the method cannot be recreated in the script process, the script is given an object that provides remote access to the object in the software under test. This remote object must be explicitly unregistered.

All the Java primitives and java.lang.String are value classes. Many other classes, such as java.lang.Rectangle are also considered to be values. Most graphical objects, such as java.awt.Component, are not values. Class is a value class if it has a value manager. A value manager supports the IManageValueClass interface, which contains the methods persistIn, persistOut, and compare.
The method getProperties() returns a Hashtable containing all the value properties of a TestObject. It does not return properties that are non-value classes. You can find the non-value properties by calling getNonValueProperties(). You can use the getProperty method to access both value and non-value properties. If you access a non-value property, the property returns a TestObject that contains a reference to the (non-value) object in the software under test. This object gets registered on your behalf, thus keeping a reference to that object in the software under test. A TestObject containing a reference is referred to as a registered object reference. An object in the software under test that has been registered is referred to as a registered object.
Do not use a registered object reference after the object it refers to has been disposed of. For example, if the reference is to a JButton in a Frame and the Frame is closed, you should not use the reference any longer. In fact, the underlying object, that is, the JButton, may be accessible, but may be in an unreliable state. Release any references that has been registered on your behalf so that when the playback session terminates, all objects that you have registered get released.
To release a reference, you must unregister it. When a script terminates, objects are not automatically unregistered. There are a variety of methods for unregistering an object - see unregister(), RationalTestScript.unregisterAll, and RationalTestScript.unregister(Object[]). You can also get an array of TestObjects that you have registered by calling RationalTestScript.getRegisteredTestObjects.

Two intertwined hierarchies of objects are supported: the parent-child hierarchy and the owner-owned hierarchy. An object cannot have both a parent and an owner. For GUI objects, the parent-child hierarchy implies containment of the child's GUI within the parent. The ownership relationship is used for a different hierarchy, for example, the relationship between a dialog box and a top-level window.

Since:

RFT1.0

Field Summary

Fields
Modifier and Type Field and Description

protected static boolean ignoreTheObjectState

protected com.rational.test.ft.object.TestObjectReference ref

Fields
Modifier and Type	Field and Description
`protected static boolean`	`ignoreTheObjectState`
`protected com.rational.test.ft.object.TestObjectReference`	`ref`

Constructor Summary

Constructors
Constructor and Description
`TestObject()` Deprecated. use ClientTestObject
`TestObject(com.rational.test.ft.sys.RegisteredObjectReference ror)` Deprecated. use ClientTestObject
`TestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)` Deprecated. use ClientTestObject
`TestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)` Deprecated. use ClientTestObject
`TestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)` Deprecated. use ClientTestObject
`TestObject(TestObject obj)` Deprecated. use ClientTestObject
`TestObject(com.rational.test.ft.object.TestObjectReference ref)` Deprecated. use ClientTestObject

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`compare(IFtVerificationPoint baseline)` Compares the baseline, that is, expected data to the actual data.
`boolean`	`compare(IFtVerificationPoint baseline, double delayBetweenRetries, double maximumTestTime)` Compares the expected result with the actual result.
`boolean`	`compareAndLog(IFtVerificationPoint baseline)` Compares the baseline, that is, expected data to the actual data and logs the result to the script log.
`boolean`	`compareAndLog(IFtVerificationPoint baseline, boolean compareTrueEqualsPass)` Allows failing verification points to return and log a passing result.
`boolean`	`equals(java.lang.Object other)` Returns `true` if the two objects are equal.
`boolean`	`exists()` Returns `true` if the object exists now, `false` otherwise.
`TestObject`	`find()` Finds the object in the software under test and returns a reference to it.
`TestObject[]`	`find(Subitem properties)` Finds all candidates that match given search criteria starting at this `TestObject`.
`TestObject[]`	`find(Subitem properties, boolean mappableOnly)` Finds all candidates that match given search criteria starting at this `TestObject`.
`java.lang.Object`	`findAndInvoke(Subitem properties, java.lang.String methodName)` Finds a `TestObject` based on `find(Subitem)` and invokes the supplied method on the `TestObject` (`invoke(String)`).
`java.lang.Object`	`findAndInvoke(Subitem properties, java.lang.String methodName, java.lang.String methodSignature, java.lang.Object[] args, boolean mappableOnly)` Finds a `TestObject` based on `find(Subitem, boolean)` and invokes the supplied method on the `TestObject` (`invoke(String, String, Object[])`).
`java.lang.Object`	`findAndInvokeProxy(Subitem properties, java.lang.String methodName, java.lang.String methodSignature, java.lang.Object[] args, boolean mappableOnly)` Finds a `TestObject` based on `find(Subitem, boolean)` and invokes the supplied method on the `TestObject's` proxy (`invoke(String, String, Object[])`).
`java.lang.Object`	`getActualData(IFtVerificationPoint baseline)` Enables access to the actual, that is, currently active data associated with a verification point.
`TestObject[]`	`getChildren()` Returns an array of references to the object's children.
`protected TestObject`	`getDescribedObject(CrossDomainContainer describedTestObject)` Used to bind a described object returned by proxy into the corresponding bound TestObject
`protected TestObject[]`	`getDescribedObjects(TestObject[] testObject)` Given an array of TestObjects, find any described objects and turn them into bound test objects.
`java.lang.String`	`getDescriptiveName()` Returns the descriptive name of the object in software under test.
`DomainTestObject`	`getDomain()` Returns the domain for the current object.
`java.lang.Object`	`getField(java.lang.String fieldName)` Returns the value of a field of the object in the SUT encapsulated by this `TestObject`.
`java.lang.Object`	`getIndexer(java.lang.String name, java.lang.Object index)` Returns the value of a `TestObject's` indexer at the given index.
`java.lang.Object`	`getIndexer(java.lang.String name, java.lang.Object[] indexes)` Same as `getIndexer(String, Object)` but used for multidimensional indexers.
`IndexerInfo[]`	`getIndexers()` Returns information about the `TestObject's` indexers, if applicable.
`TestObject[]`	`getMappableChildren()` Returns an array of references to the object's mappable children.
`TestObject`	`getMappableParent()` Returns a reference to the parent object that appears in the object map.
`com.rational.test.ft.object.map.IObjectMapPropertySet`	`getMapProperties()`
`MethodInfo[]`	`getMethods()` Returns a an array of `MethodInfo` objects describing the methods supported by the object.
`java.lang.String`	`getNameInScript()`
`java.util.Hashtable`	`getNonValueProperties()` Returns a `Hashtable` containing names of properties whose values are not value classes.
`java.lang.String`	`getObjectClassName()` Returns the complete class name for the object in the software under test.
`java.lang.String`	`getObjectCustomClassName()` Returns the custom class name for the object in the software under test.
`com.rational.test.ft.object.TestObjectReference`	`getObjectReference()` Returns the object reference.
`TestObject[]`	`getOwnedObjects()` Returns an array of references to the objects owned by this object.
`TestObject`	`getOwner()` Returns a reference to the owner object.
`TestObject`	`getParent()` Returns a reference to the parent object.
`ProcessTestObject`	`getProcess()` Returns a `ProcessTestObject` for the object in the software under test.
`java.util.Hashtable`	`getProperties()` Returns a `Hashtable` containing properties.
`java.lang.Object`	`getProperty(java.lang.String propertyName)` Returns the value of the specified property.
`java.lang.Object`	`getPropertyFromMap(java.lang.String propertyName)` Returns a property value from the map.
`java.util.Hashtable`	`getRecognitionProperties()` Returns the properties that are useful for recognition.
`int`	`getRecognitionPropertyWeight(java.lang.String propertyName)` Returns an indication of how useful this property is for recognition.
`ScriptCommandFlags`	`getScriptCommandFlags()` Returns an active state value that reflects the state of the `TestObejct` at the time of the call.
`java.util.Hashtable`	`getStandardProperties()` Returns a complete set of standard properties for the associated `TestObject`.
`ITestData`	`getTestData(java.lang.String testDataType)` Constructs the specified verification data object.
`java.util.Hashtable`	`getTestDataTypes()` Returns a `Hashtable` of data type descriptions of the verification point data available with the associated object in the software under test.
`TestObject`	`getTopMappableParent()` Returns a reference to the topmost mappable parent for an object.
`TestObject`	`getTopParent()` Returns a reference to the topmost parent for an object.
`int`	`hashCode()` Returns Using TestObject in hash functions is discouraged.
`java.lang.Object`	`invoke(java.lang.String method)` Invokes a method with no arguments on the object in the software under test.
`java.lang.Object`	`invoke(java.lang.String method, boolean onEventDispatchThread)` A wrapper method for the invoke() API to execute a given method on the Event Dispatch Thread.
`java.lang.Object`	`invoke(java.lang.String method, java.lang.String methodSignature, java.lang.Object[] args)` Invokes a method on the object in the software under test.
`java.lang.Object`	`invoke(java.lang.String method, java.lang.String signature, java.lang.Object[] args, boolean onEventDispatchThread)` A wrapper method for the invoke() API to execute a given method on the Event Dispatch Thread.
`protected java.lang.Object`	`invokeProxy(java.lang.String method)` Invokes a method on the object in the software under test.
`protected java.lang.Object`	`invokeProxy(java.lang.String method, java.lang.String methodSignature, java.lang.Object[] args)` Invokes a method on the proxy for an object in the software under test.
`protected java.lang.Object`	`invokeProxy(java.lang.String method, java.lang.String methodSignature, java.lang.Object[] args, boolean ignoreState)`
`boolean`	`isHtmlWebui()`
`boolean`	`isLoggedDuringUnregister()`
`boolean`	`isMappedObject()` Returns `true` if the object contains a mapped reference.
`boolean`	`isSameObject(TestObject other)` Returns `true` if the supplied `TestObject` represents the same underlying object in the software under test.
`protected boolean`	`isScreenTestObject()` Check to see if this `TestObject` is indeed the Screen.
`boolean`	`isTopLevelTestObject()` Check to see if this `TestObject` is indeed the Top Level Test Object.
`boolean`	`performTest(IFtVerificationPoint baseline)` Captures, compares and logs active data available relative to this object instance against the supplied baseline data.
`boolean`	`performTest(IFtVerificationPoint baseline, boolean compareTrueEqualsPass)` Captures, compares and logs active data available relative to this object instance against the supplied baseline data.
`boolean`	`performTest(IFtVerificationPoint baseline, double delayBetweenRetries, double maximumTestTime)` Captures, compares and logs active data available relative to this object instance against the supplied baseline data.
`boolean`	`performTest(IFtVerificationPoint baseline, double delayBetweenRetries, double maximumTestTime, boolean compareTrueEqualsPass)` Captures, compares and logs active data available relative to this object instance against the supplied baseline data.
`void`	`setIndexer(java.lang.String name, java.lang.Object[] indexes, java.lang.Object value)` Same as `setIndexer(String, Object[], Object)` but used for multidimensional indexers.
`void`	`setIndexer(java.lang.String name, java.lang.Object index, java.lang.Object value)` Sets the value of a `TestObject's` indexer.
`void`	`setLoggedDuringUnregister(boolean loggedDuringUnregister)`
`void`	`setMapProperties(com.rational.test.ft.object.map.IObjectMapPropertySet propSet)`
`void`	`setProperty(java.lang.String propertyName, java.lang.Object value)` Sets the specified property to the specified value.
`java.lang.String`	`toString()` Returns a string describing the `TestObject`, not a string describing the object in the software under test.
`void`	`unregister()` Unregisters a `TestObject` reference.
`ITestData`	`updateTestData(java.lang.String testDataType, ITestData testData)` Updates the supplied test data object and returns it.
`void`	`waitForExistence()` Waits the default time until an object exists.
`void`	`waitForExistence(double maximum_find_object_time, double find_object_wait_between_retry)` Waits until an object exists.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ref

protected com.rational.test.ft.object.TestObjectReference ref

ignoreTheObjectState

protected static boolean ignoreTheObjectState