com.rational.test.ft.domain
Class ProcessDomainProxy

java.lang.Object   com.rational.test.ft.sys.RegisteredObject       com.rational.test.ft.domain.ProxyTestObject
          com.rational.test.ft.domain.DomainProxy
              com.rational.test.ft.domain.ProcessDomainProxy

All Implemented Interfaces:

IChannelObject, IDataDriven, IProxyBase

public class ProcessDomainProxy
extends DomainProxy

The class for the Java domain proxy.

Since:

RFT1.0

Field Summary

Fields inherited from class com.rational.test.ft.domain.ProxyTestObject

BROWSERTABTESTOBJECT_CLASSNAME, BROWSERTESTOBJECT_CLASSNAME, COLORDIALOGTESTOBJECT_CLASSNAME, CROSSDOMAINCONTAINER_CLASSNAME, debug, DOCUMENTTESTOBJECT_CLASSNAME, DOMAINTESTOBJECT_CLASSNAME, ECLIPSETOPLEVELTESTOBJECT_CLASSNAME, EMBEDDEDBROWSERTESTOBJECT_CLASSNAME, FILEDIALOGTESTOBJECT_CLASSNAME, FRAMESUBITEMTESTOBJECT_CLASSNAME, FRAMETESTOBJECT_CLASSNAME, GEFEDITPARTTESTOBJECT_CLASSNAME, GUISUBITEMTESTOBJECT_CLASSNAME, GUITESTOBJECT_CLASSNAME, INTERNALFRAMETESTOBJECT_CLASSNAME, MESSAGEBOXTESTOBJECT_CLASSNAME, PALETTEGUISUBITEMTESTOBJECT_CLASSNAME, PROCESSTESTOBJECT_CLASSNAME, SCROLLSUBITEMTESTOBJECT_CLASSNAME, SCROLLTESTOBJECT_CLASSNAME, SELECTGUISUBITEMTESTOBJECT_CLASSNAME, SELECTSCROLLGUISUBITEMTESTOBJECT_CLASSNAME, SHELLTESTOBJECT_CLASSNAME, STATELESSGUISUBITEMTESTOBJECT_CLASSNAME, SUBITEMTESTOBJECT_CLASSNAME, TABITEMTESTOBJECT_CLASSNAME, TESTOBJECT_CLASSNAME, TEXTGUISUBITEMTESTOBJECT_CLASSNAME, TEXTGUITESTOBJECT_CLASSNAME, TEXTSCROLLTESTOBJECT_CLASSNAME, TEXTSELECTGUISUBITEMTESTOBJECT_CLASSNAME, TOGGLEGUITESTOBJECT_CLASSNAME, TOGGLETESTOBJECT_CLASSNAME, TOPLEVELSUBITEMTESTOBJECT_CLASSNAME, TOPLEVELTESTOBJECT_CLASSNAME, TRACKBARTESTOBJECT_CLASSNAME, vomClippedRectangle

Fields inherited from class com.rational.test.ft.sys.RegisteredObject

theTestObject

Fields inherited from interface com.rational.test.ft.domain.IDataDriven

INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS

Constructor Summary

ProcessDomainProxy(java.lang.Object theObjectInTheSUT)
Establishes the object as a member variable for the proxy.

Method Summary

java.util.Hashtable	getProperties() Returns a complete set of properties for the associated test object.
java.lang.Object	getProperty(java.lang.String propertyName) Gets the value for a specific property.
java.util.Hashtable	getRecognitionProperties() Returns an enumeration of properties used to identify the associated test object.
int	getRecognitionPropertyWeight(java.lang.String propertyName) Returns an indication of how useful this property is for recognition.
java.util.Hashtable	getStandardProperties() Returns a complete set of consistent properties for the associated test object.
com.rational.test.ft.vp.ITestData	getTestData(java.lang.String testDataType) Constructs the specified verification data object.
java.util.Hashtable	getTestDataTypes() Returns an enumeration of objects of type String that describe the verification point data available with the associated object.
void	setProperty(java.lang.String propertyName, java.lang.Object value) Sets the value for a specific property.
boolean	shouldBeMapped() Determines whether the object is interesting from a persistent testability sense and therefore should be added to the object map.
com.rational.test.ft.vp.ITestData	updateTestData(java.lang.String testDataType, com.rational.test.ft.vp.ITestData testData) Updates the supplied test data object and returns it.

Methods inherited from class com.rational.test.ft.domain.DomainProxy

addRecognitionProperty, getChildren, getDescriptiveName, getImplementationName, getIndexer, getIndexers, getMappableChildren, getMappableParent, getMethods, getMethodSpecForPoint, getName, getNonValueProperties, getOwnedObjects, getOwner, getParent, getTestDomain, getTestObjectClassName, getTopMappableParent, getTopObjects, getTopParent, getUniqueId, hasAddedRecognitionProperties, invokeConstructor, invokeStaticMethod, prepareDomainsForRecording, prepareToStop, processMouseEvent, readyToStop, setIndexer

Methods inherited from class com.rational.test.ft.domain.ProxyTestObject

addDataDrivableCommands, baseClassMatch, canTakeVP, equals, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChannel, getChildren, getDataDrivableCommand, getDataDrivableCommands, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectClassName, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getRole, getScriptCommandAnchor, getScriptCommandFlags, getVisualClippableParent, getVisualClippedRectangle, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction

Methods inherited from class com.rational.test.ft.sys.RegisteredObject

addProxyReference, dereference, getObject, getRegisteredId, getTransactionId, isReferenced, isReleaseRequired, register, registerTransiently, release, toString, unregister

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProcessDomainProxy

public ProcessDomainProxy(java.lang.Object theObjectInTheSUT)

Establishes the object as a member variable for the proxy. All interactions with the supplied object are performed through this class.

Since:

RFT1.0

Method Detail

getTestDataTypes

public java.util.Hashtable getTestDataTypes()

Returns an enumeration of objects of type String that describe the verification point data available with the associated object.

Specified by:

getTestDataTypes in class ProxyTestObject

Returns:

An enumeration of String objects that describe the various types of verification data available from this proxy.

Since:

RFT1.0

See Also:

getTestData(String)

getTestData

public com.rational.test.ft.vp.ITestData getTestData(java.lang.String testDataType)

Constructs the specified verification data object. The testDataType parameter is one of the values returned by getTestDataTypes.

Overrides:

getTestData in class ProxyTestObject

Parameters:

testDataType - A test data type supplied by getTestDataTypes().

Returns:

The verification data for the supplied type.

Since:

RFT1.0

See Also:

getTestDataTypes()

updateTestData

public com.rational.test.ft.vp.ITestData updateTestData(java.lang.String testDataType,                                                         com.rational.test.ft.vp.ITestData testData)

Updates the supplied test data object and returns it. The testDataType parameter is one of the values returned by getTestDataTypes. The testData is a previously-supplied ITestData object that must be updated to reflect the current state of the associated test object.

Overrides:

updateTestData in class ProxyTestObject

Parameters:

testDataType - A test data type supplied by getTestDataTypes().

testData - The test data base object that requires updating.

Returns:

The testData passed in with appropriate updates.

Since:

RFT1.0

See Also:

getTestDataTypes(), ITestData

getRecognitionProperties

public java.util.Hashtable getRecognitionProperties()

Returns an enumeration of properties used to identify the associated test object. Examples of useful recognition properties are the programmatic name or a persistent description. Less interesting are the visible text on a button or label, or the tooltip text, or possibly the foreground color. Uninteresting properties are the transient properties, such as hasFocus or isShowing.

Specified by:

getRecognitionProperties in class ProxyTestObject

Returns:

An enumeration of recognition properties. The returned objects are of class TestObjectProperty.

Since:

RFT1.0

See Also:

ProxyTestObject.getRecognitionPropertyWeight(String), ProxyTestObject.getProperty(String), ProxyTestObject.addRecognitionProperty(String,Object,int)

getRecognitionPropertyWeight

public int getRecognitionPropertyWeight(java.lang.String propertyName)

Returns an indication of how useful this property is for recognition. A value of 0 indicates not useful at all, and a value of 100 indicates that the property is extremely useful for recognition.

Specified by:

getRecognitionPropertyWeight in class ProxyTestObject

Parameters:

propertyName - The name of the recognition property to return a weight value for.

Since:

RFT1.0

See Also:

ProxyTestObject.getRecognitionProperties()

getProperties

public java.util.Hashtable getProperties()

Description copied from class: ProxyTestObject

Returns a complete set of properties for the associated test object. The meaning of a property is specific to the test domain and the test object. Typically, this is a set of name/value pairs that describe the test object and its active state. Properties such as font, colors, and coordinate information are typically associated with a GUI test object. Associated data and state information can also be returned, depending on the test object.

This method does not return properties whose values are references to objects. The method ProxyTestObject.getNonValueProperties() returns information about such properties.

Specified by:

getProperties in class ProxyTestObject

Returns:

The set of known properties associated with a test object.

Since:

RFT1.0

See Also:

ProxyTestObject.getProperty(String), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getStandardProperties(), ProxyTestObject.getNonValueProperties()

getStandardProperties

public java.util.Hashtable getStandardProperties()

Description copied from class: ProxyTestObject

Returns a complete set of consistent properties for the associated test object. Consistent properties are those properties that exist regardless of the platform the test object is running on. Domains that do not support the notion of standard properties should implement this method identically to ProxyTestObject.getProperties(). The HTML domain supports standard properties and returns properties that are consistent across browser versions. The Java domain does not support this notion of standard properties. In this domain, getStandardProperties, and getProperties do the same thing. For HTML, standard properties are a subset of the properties returned by getProperties(). The meaning of a property is specific to the test domain and the test object. Typically, this is a set of name/value pairs that describe the test object and its active state. Properties such as font, colors, and coordinate information are typically associated with a GUI test object. Associated data and state information can also be returned, depending on the test object.

Specified by:

getStandardProperties in class ProxyTestObject

Returns:

The set of standard properties associated with a test object.

Since:

RFT1.0

See Also:

ProxyTestObject.getProperty(String), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getProperties(), ProxyTestObject.getNonValueProperties()

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Gets the value for a specific property.

Specified by:

getProperty in class ProxyTestObject

Parameters:

propertyName - The name of the property to fetch.

Returns:

The active value of the specified property for the associated test object.

Since:

RFT1.0

See Also:

ProxyTestObject.getProperties(), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getRecognitionProperties(), ProxyTestObject.addRecognitionProperty(String,Object,int)

setProperty

public void setProperty(java.lang.String propertyName,                         java.lang.Object value)

Sets the value for a specific property.

Specified by:

setProperty in class ProxyTestObject

Parameters:

propertyName - The name of the property to redefine. This name is the same as that returned by getProperties().

Since:

RFT1.0

See Also:

ProxyTestObject.getProperties(), ProxyTestObject.getProperty(String)

shouldBeMapped

public boolean shouldBeMapped()

Determines whether the object is interesting from a persistent testability sense and therefore should be added to the object map. An object is considered interesting under one or more of the following conditions:

• Significant user actions can be performed against the object.

• The object contains testable properties.

• The object has interesting data associated with it.

Examples of objects that are not interesting include:

• Simple container objects with no interesting data.

• Decorative objects with no interesting side effects.

• Duplicate objects (mirroring data from another available object).

Note that if the object is a container, the children are examined even if this method returns false.

Specified by:

shouldBeMapped in class ProxyTestObject

Returns:

true if the represented control is interesting other than for nested objects.

Since:

RFT1.0