IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester Proxy SDK Reference

Project Version 2.3

com.rational.test.ft.domain
Class TestDomainImplementation

java.lang.Object   extended by com.rational.test.ft.domain.TestDomain
      extended by com.rational.test.ft.domain.TestDomainImplementation
Direct Known Subclasses:
ProcessDomainImplementation, TestDomainImplementationJava

public abstract class TestDomainImplementation
extends TestDomain

The base class for all domain implementations. This class is the factory object for the domain's proxy objects. Domain implementations are always created by a TestContext.

Since:
RFT1.0

Constructor Summary
TestDomainImplementation(java.lang.String domainName)
           
TestDomainImplementation(java.lang.String domainName, boolean isGraphical)
           
 
Method Summary
 boolean equals(java.lang.Object other)
          Compares two domains based on name.
 com.rational.test.ft.object.manager.FindResult find(com.rational.test.ft.object.map.IMappedTestObject[] pathToFind)
           
abstract  int getActionRecordingFlags()
          Returns the bits that control the recording of actions for objects belonging to this domain.
 ProxyTestObject getDescribedObject(DescribedObject describedObject)
          Find the object described by the set of properties in the DescribedObject.
abstract  DomainProxy getDomainProxy()
          Returns the proxy for this domain object.
abstract  java.lang.String getImplementationName()
          Returns the name of the domain implementation.
abstract  ProxyTestObject getProxy(java.lang.Object theObject)
          Returns a proxy object for the specified object.
abstract  ProxyTestObject getTopLevelObject(com.rational.test.ft.sys.graphical.Window window)
          Returns the topLevelObject that matches the specified window.
 ProxyTestObject getTopLevelObject(com.rational.test.ft.sys.graphical.Window topWindow, com.rational.test.ft.sys.graphical.Window pointWindow)
           
abstract  java.util.Enumeration getTopLevelObjects()
          Returns an enumeration for the top-level objects within this domain implementation.
abstract  void registerProxies(java.util.Enumeration proxies)
          Registers proxies for this domain implementation.
 boolean supportVOMOptimization(int optimizationCode, ProxyTestObject selectedObject)
          Return true if the domain support different Visual Object Map Optimizations.
 
Methods inherited from class com.rational.test.ft.domain.TestDomain
getName, isGraphical, isNamed
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TestDomainImplementation

public TestDomainImplementation(java.lang.String domainName)
Since:
RFT1.0

TestDomainImplementation

public TestDomainImplementation(java.lang.String domainName,                                 boolean isGraphical)
Since:
RFT1.0
Method Detail

getImplementationName

public abstract java.lang.String getImplementationName()
Returns the name of the domain implementation.

Since:
RFT1.0

getTopLevelObjects

public abstract java.util.Enumeration getTopLevelObjects()
Returns an enumeration for the top-level objects within this domain implementation.

Since:
RFT1.0

getTopLevelObject

public abstract ProxyTestObject getTopLevelObject(com.rational.test.ft.sys.graphical.Window window)
Returns the topLevelObject that matches the specified window. This method should throw an exception if the domain is not graphical. If the Window cannot be matched, a value of null should be returned.

Parameters:
window - The window object to match.
Returns:
The top level object matching window in this test domain, or null if not found.
Since:
RFT1.0

getTopLevelObject

public ProxyTestObject getTopLevelObject(com.rational.test.ft.sys.graphical.Window topWindow,                                          com.rational.test.ft.sys.graphical.Window pointWindow)

getProxy

public abstract ProxyTestObject getProxy(java.lang.Object theObject)
Returns a proxy object for the specified object. If the object is relative to an associated domain, that domain should be called to return a proxy for the object. If the object is not part of this domain or an associated domain, a null object should be returned.

Parameters:
theObject - The object to return a proxy object for.
Returns:
A proxy for the specified object.
Since:
RFT1.0

equals

public boolean equals(java.lang.Object other)
Description copied from class: TestDomain
Compares two domains based on name.

Overrides:
equals in class TestDomain

registerProxies

public abstract void registerProxies(java.util.Enumeration proxies)
Registers proxies for this domain implementation.

Since:
RFT1.0

getDomainProxy

public abstract DomainProxy getDomainProxy()
Returns the proxy for this domain object.

Since:
RFT1.0

getActionRecordingFlags

public abstract int getActionRecordingFlags()
Returns the bits that control the recording of actions for objects belonging to this domain. The supported flags are:

Since:
RFT1.0

getDescribedObject

public ProxyTestObject getDescribedObject(DescribedObject describedObject)
Find the object described by the set of properties in the DescribedObject.

Since:
RFT2.0

find

public com.rational.test.ft.object.manager.FindResult find(com.rational.test.ft.object.map.IMappedTestObject[] pathToFind)

supportVOMOptimization

public boolean supportVOMOptimization(int optimizationCode,                                       ProxyTestObject selectedObject)
Return true if the domain support different Visual Object Map Optimizations.

Parameters:
optimizationCode - The different optimizations
selectedObject - The selected ProxyTestObject
Returns:
true if the domain supports VOM optimization