|
IBM Rational Functional Tester Version 8.2.1 IBM Rational Functional Tester API Reference Project Version 2.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITestObjectReference
Defines the standard interface for all TestObjectReference
objects. These
include the mapped object reference, process reference, and remote proxy reference.
TestObject.getObjectReference()
Method Summary | |
---|---|
ITestObjectReference |
getAnchor()
Returns an anchor object or null |
SpyMappedTestObject |
getMappedTestObject()
Provide access to the TestObject related information. |
OSProcessInformation |
getProcess()
Provide access to the Process related information. |
RemoteProxyReference |
getRemoteProxyReference()
Provide access to the RemoteProxyReference |
long |
getScriptCommandFlags()
Provide access to the script command flags |
java.lang.Object |
getTarget()
Returns the target object of reference. |
TestContext.Reference |
getTestContextReference()
Provide access to the TestContext.Reference |
boolean |
isBound()
Returns true if the object is bound. |
boolean |
isDescribed()
Returns true>if the object is described. |
boolean |
isProcess()
Returns true if the object is a process-reference object. |
Method Detail |
---|
java.lang.Object getTarget()
this
instance.
ITestObjectReference instance | Return type |
---|---|
TOMappedObjectReference | SpyMappedTestObject |
TOProcessReference | OSProcessInformation |
TORemoteProxyReference | RemoteProxyReference |
TODescribedObjectReference | null |
ITestObjectReference tof = classicsJava().getObjectReference();
Object target = tof.getTarget();
ITestObjectReference getAnchor()
null.
- Returns:
- java.lang.Object An
ITestObjectReference
object - Detail description:
- If the anchor is not supported in this type of reference object, null is returned.
Returns
ITestObjectReference
if this
object is an instance of TOMappedObjectReference, otherwise null.
- Example:
- Find the anchor for the particular TestObject
ITestObjectReference tof = classicsJava().getObjectReference();
Object anchor = tof.getAnchor();
- Since:
- RFT6.1.1.1
isBound
boolean isBound()
- Returns
true
if the object is bound.
- Returns:
true if the ITestObjectReference is bound
Detail description:
- A TestObjectReference is said to be bound if the TestObject is found using "find" API's.
All bound
TestObject
need to be unregistered explicitly.
- Example:
- Check if the found test object is bound
TestObject []to = classicsJava().find();
ITestObjectReference tof = to[0].getObjectReference();
boolean isBound = tof.isBound();
if(isBound)
to[0].unregister()
- Since:
- RFT6.1.1.1
- See Also:
TestObject.unregister()
,
TestObject.find()
isProcess
boolean isProcess()
- Returns
true
if the object is a process-reference object.
- Returns:
true, if the object is process-reference object
Detail description:
- Returns
true
in case of ProcessTestObject
,otherwise false
- Example:
- Check if the TestObject references a process-reference object
ProcessTestObject pto = classicsJava().getProcess();
ITestObjectReference tof = pto.getObjectReference();
boolean isProcess = tof.isProcess();
- Since:
- RFT6.1.1.1
getTestContextReference
TestContext.Reference getTestContextReference()
- Provide access to the
TestContext.Reference
- Returns:
- TestContext.Reference if the object is bound, otherwise null.
- Detail description:
- Returns the
testContextReference
for a bound object. Returns null
if the object is not bound,
- Example:
TestObject to = classicsJava().find();
ITestObjectReference tof = to.getObjectReference();
TestContext.Reference testContextRefence = tof.getTestContextReference();
- Since:
- RFT6.1.1.1
getRemoteProxyReference
RemoteProxyReference getRemoteProxyReference()
- Provide access to the
RemoteProxyReference
- Returns:
- RemoteProxyRefernce if
this
is a Remote proxy reference, otherwise null
- Detail description:
- Returns the
RemoteProxyReference
if this
is a remote proxy reference object;
if not, it returns null
.
- Example:
TestObject to = classicsJava().find();
ITestObjectReference tof = to.getObjectReference();
RemoteProxyReference rpf = tof.getRemoteProxyReference();
- Since:
- RFT6.1.1.1
getProcess
OSProcessInformation getProcess()
- Provide access to the Process related information.
- Returns:
- com.rational.test.ft.sys.OSProcessInformation if the TestObject is of ProcessTestObject, otherwise null.
- Detail description:
- Returns the process information if this is a process-reference object, otherwise
null
- Example:
ProcessTestObject pto = classicsJava().getProcess();
ITestObjectReference tof = pto.getObjectReference();
OSProcessInformation ospi = tof.getProcess();
- Since:
- RFT6.1.1.1
getMappedTestObject
SpyMappedTestObject getMappedTestObject()
- Provide access to the TestObject related information.
- Returns:
- com.rational.test.ft.object.map.SpyMappedTestObject if the TestObject is MappedTestObject.
- Detail description:
- Returns the mapped test object if this is a mapped-object reference object, otherwise
null
.
Mapped Test Object are TestObjects that are obtained from the object map.
- Example:
- SpyMappedTestObject smto = classicsJava().getObjectReference().getMappedTestObject();
- Since:
- RFT6.1.1.1
getScriptCommandFlags
long getScriptCommandFlags()
- Provide access to the script command flags
- Returns:
- long The ScriptCommandFlags. By default it is
ScriptCommandFlags.NO_FLAGS
- Detail description:
- Returns the
ScriptCommandFlags
associated with the TestObject
. If no flags are associated with this test object,
NO_FLAGS
is returned.
A TestObject
may be ScriptCommandFlags.DISABLED
or ScriptCommandFlags.NOT_SHOWING
, that is, invisible when an
action is performed against it. Actions must be performed against the object when it is in the appropriate state. For example, you may want to wait
for an object to become ScriptCommandFlags.ENABLED
before acting upon it.
- Example:
- long scriptCommand = classicsJava().getObjectReference().getScriptCommandFlags();
- Since:
- RFT6.1.1.1
isDescribed
boolean isDescribed()
- Returns
true>if the object is described.
- Returns:
- boolean -
true
if the proxy reference is described, false
otherwise - Detail description:
- Returns
true
if this
is a described proxy reference object;
- Example:
boolean isDescribed = classicsJava().getObjectReference().isDescribed();
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD