IBM Rational Functional Tester
Version 6.1
IBM Rational Functional Tester API Reference

Project Version 2.0

com.rational.test.ft.object.interfaces
Interface ITestObjectReference


public interface ITestObjectReference

Defines the standard interface for all TestObjectReference objects. These include the mapped object reference, process reference, and remote proxy reference.

Since:
RFT1.0

Method Summary
 com.rational.test.ft.object.TestObjectReference getAnchor()
          Returns an anchor, or null if the anchor is not supported in this type of reference object.
 com.rational.test.ft.object.map.SpyMappedTestObject getMappedTestObject()
          Returns the mapped test object if this is a mapped-object reference object; null otherwise.
 com.rational.test.ft.sys.OSProcessInformation getProcess()
          Returns the process information if this is a process-reference object; if not, it returns null.
 com.rational.test.ft.sys.RemoteProxyReference getRemoteProxyReference()
          Returns the RemoteProxyReference if this is a remote proxy reference object; if not, it returns null.
 long getScriptCommandFlags()
          Returns the ScriptCommandFlags associated with the TestObject.
 java.lang.Object getTarget()
          Returns the target object of reference.
 com.rational.test.ft.sys.TestContext.Reference getTestContextReference()
          Returns the testContextReference for a bound object; if the object is not bound, it returns null.
 boolean isBound()
          Returns true if the object is bound.
 boolean isDescribed()
           
 boolean isProcess()
          Returns true if the object is a process-reference object.
 

Method Detail

getTarget

public java.lang.Object getTarget()
Returns the target object of reference. The particular target object depends on the kind of reference object.

Since:
RFT1.0

getAnchor

public com.rational.test.ft.object.TestObjectReference getAnchor()
Returns an anchor, or null if the anchor is not supported in this type of reference object.

Since:
RFT1.0

isBound

public boolean isBound()
Returns true if the object is bound.

Since:
RFT1.0

isProcess

public boolean isProcess()
Returns true if the object is a process-reference object.

Since:
RFT1.0

getTestContextReference

public com.rational.test.ft.sys.TestContext.Reference getTestContextReference()
Returns the testContextReference for a bound object; if the object is not bound, it returns null.

Since:
RFT1.0

getRemoteProxyReference

public com.rational.test.ft.sys.RemoteProxyReference getRemoteProxyReference()
Returns the RemoteProxyReference if this is a remote proxy reference object; if not, it returns null.

Since:
RFT1.0

getProcess

public com.rational.test.ft.sys.OSProcessInformation getProcess()
Returns the process information if this is a process-reference object; if not, it returns null.

Since:
RFT1.0

getMappedTestObject

public com.rational.test.ft.object.map.SpyMappedTestObject getMappedTestObject()
Returns the mapped test object if this is a mapped-object reference object; null otherwise.

Since:
RFT1.0

getScriptCommandFlags

public long getScriptCommandFlags()
Returns the ScriptCommandFlags associated with the TestObject. If no flags are associated with this test object, NO_FLAGS is returned.

Since:
RFT1.0

isDescribed

public boolean isDescribed()