IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft.object.interfaces.siebel
Class SiebTestObject

java.lang.Object   extended by com.rational.test.ft.object.interfaces.TestObject
      extended by com.rational.test.ft.object.interfaces.ClientTestObject
          extended by com.rational.test.ft.object.interfaces.GuiTestObject
              extended by com.rational.test.ft.object.interfaces.siebel.SiebTestObject
All Implemented Interfaces:
IGraphical, ISiebTestObject
Direct Known Subclasses:
SiebAlphaTabsTestObject, SiebAppletTestObject, SiebApplicationTestObject, SiebButtonTestObject, SiebCalculatorTestObject, SiebCalendarTestObject, SiebCheckboxTestObject, SiebCommunicationsToolbarTestObject, SiebCurrencyTestObject, SiebInkDataTestObject, SiebListTestObject, SiebMenuTestObject, SiebPageTabsTestObject, SiebPDQTestObject, SiebPicklistTestObject, SiebRichTextTestObject, SiebScreenTestObject, SiebScreenViewsTestObject, SiebTaskAssistantTestObject, SiebTaskLinkTestObject, SiebTaskStepTestObject, SiebTaskTestObject, SiebTaskUIPaneTestObject, SiebTextAreaTestObject, SiebTextTestObject, SiebThreadbarTestObject, SiebToolbarTestObject, SiebTreeTestObject, SiebViewAppletsTestObject, SiebViewTestObject

public class SiebTestObject
extends GuiTestObject
implements ISiebTestObject

Provides script access to Siebel objects.

Since:
RFT2.1

Field Summary
 
Fields inherited from class com.rational.test.ft.object.interfaces.TestObject
ref
 
Constructor Summary
SiebTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
          For internal use.
SiebTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
          For internal use.
SiebTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
          For internal use.
SiebTestObject(TestObject obj)
          Constructs one TestObject from another.
SiebTestObject(com.rational.test.ft.object.TestObjectReference ref)
          For internal use.
 
Method Summary
protected static Anchor atChild(Property[] properties)
           
protected static Anchor atChild(java.lang.String propName, java.lang.Object propValue)
           
protected static Anchor atDescendant(Property[] properties)
           
protected static Anchor atDescendant(java.lang.String propName, java.lang.Object propValue)
           
 TestObject getChildOfName(java.lang.String repositoryName)
          Gets a child object when given the Siebel repository name.
protected static TestObject getChildOfName(TestObject parent, java.lang.String repositoryName)
           
 TestObject getChildOfNameAndType(java.lang.String repositoryName, java.lang.String typeName)
          Gets a child object when given the Siebel repository name and classname.
protected static TestObject getChildOfNameAndType(TestObject parent, java.lang.String repositoryName, java.lang.String typeName)
           
 TestObject getChildOfUIName(java.lang.String UIName)
          Gets the child object when given the Siebel UIName of the object.
protected static TestObject getChildOfUIName(TestObject parent, java.lang.String UIName)
           
 TestObject getChildOfUINameAndType(java.lang.String UIName, java.lang.String typeName)
          Gets a child object when given the Siebel UI name and classname.
protected static TestObject getChildOfUINameAndType(TestObject parent, java.lang.String UIName, java.lang.String typeName)
           
 TestObject[] getChildren()
          Gets the immediate Siebel children of the Siebel object.
protected static TestObject[] getChildren(TestObject parent)
           
 TestObject[] getChildrenOfType(java.lang.String typeName)
          Gets the Siebel children when given the Siebel classname.
protected static TestObject[] getChildrenOfType(TestObject parent, java.lang.String typeName)
           
 TestObject[] getDescendantsOfName(java.lang.String repositoryName)
          Gets every Siebel descendant when given the parent and the Siebel repository name.
protected static TestObject[] getDescendantsOfName(TestObject parent, java.lang.String repositoryName)
           
 TestObject[] getDescendantsOfNameAndType(java.lang.String repositoryName, java.lang.String typeName)
          Gets every Siebel descendant when given the Siebel repository name and classname.
protected static TestObject[] getDescendantsOfNameAndType(TestObject parent, java.lang.String repositoryName, java.lang.String typeName)
           
 TestObject[] getDescendantsOfType(java.lang.String typeName)
          Gets every Siebel descendant when given the Siebel classname.
protected static TestObject[] getDescendantsOfType(TestObject parent, java.lang.String typeName)
           
 TestObject[] getDescendantsOfUIName(java.lang.String UIName)
          Gets every Siebel descendant when given the parent and the Siebel UI name.
protected static TestObject[] getDescendantsOfUIName(TestObject parent, java.lang.String UIName)
           
 TestObject[] getDescendantsOfUINameAndType(java.lang.String UIName, java.lang.String typeName)
          Gets every Siebel descendant when given the Siebel UI name (the display name in the user interface) and classname.
protected static TestObject[] getDescendantsOfUINameAndType(TestObject parent, java.lang.String UIName, java.lang.String typeName)
           
 java.lang.Object submit(java.lang.String method)
           
 java.lang.Object submit(java.lang.String method, int param)
           
 java.lang.Object submit(java.lang.String method, int param1, int param2)
           
 java.lang.Object submit(java.lang.String method, java.lang.Object[] subItems)
           
 java.lang.Object submit(java.lang.String method, java.lang.String param)
           
 java.lang.Object submit(java.lang.String method, java.lang.String param1, java.lang.String param2)
           
 
Methods inherited from class com.rational.test.ft.object.interfaces.GuiTestObject
canTakeVP, click, click, click, click, clickRadio, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, ensureObjectIsVisible, getChildAtPoint, getClippedScreenRectangle, getImage, getImage, getScreenPoint, getScreenPoint, getScreenRectangle, getScreenSnapshot, getVisibleArea, hasFocus, hover, hover, hover, hover, invokeProxyWithGuiDelay, invokeProxyWithGuiDelay, isEnabled, isOpaque, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint
 
Methods inherited from class com.rational.test.ft.object.interfaces.ClientTestObject
exists, find, find, findAndInvoke, findAndInvokeProxy, invoke, invokeProxy, unregister, waitForExistence
 
Methods inherited from class com.rational.test.ft.object.interfaces.TestObject
compare, compare, compareAndLog, compareAndLog, equals, find, findAndInvoke, getActualData, getDescribedObject, getDescribedObjects, getDescriptiveName, getDomain, getField, getIndexer, getIndexer, getIndexers, getMappableChildren, getMappableParent, getMapProperties, getMethods, getNameInScript, getNonValueProperties, getObjectClassName, getObjectCustomClassName, getObjectReference, getOwnedObjects, getOwner, getParent, getProcess, getProperties, getProperty, getPropertyFromMap, getRecognitionProperties, getRecognitionPropertyWeight, getScriptCommandFlags, getStandardProperties, getTestData, getTestDataTypes, getTopMappableParent, getTopParent, hashCode, invoke, invokeProxy, isMappedObject, isSameObject, isScreenTestObject, isTopLevelTestObject, performTest, performTest, performTest, performTest, setIndexer, setIndexer, setMapProperties, setProperty, toString, updateTestData, waitForExistence
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SiebTestObject

public SiebTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
For internal use.

Since:
RFT2.1

SiebTestObject

public SiebTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,                       TestObject anchor)
For internal use.

Since:
RFT2.1

SiebTestObject

public SiebTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,                       TestObject anchor,                       long scriptCommandFlags)
For internal use.

Since:
RFT2.1

SiebTestObject

public SiebTestObject(com.rational.test.ft.object.TestObjectReference ref)
For internal use.

Since:
RFT2.1

SiebTestObject

public SiebTestObject(TestObject obj)
Constructs one TestObject from another. Both are references to the same object.

Since:
RFT2.1
Method Detail

submit

public java.lang.Object submit(java.lang.String method)
Specified by:
submit in interface ISiebTestObject

submit

public java.lang.Object submit(java.lang.String method,                                java.lang.Object[] subItems)
Specified by:
submit in interface ISiebTestObject

submit

public java.lang.Object submit(java.lang.String method,                                int param)
Specified by:
submit in interface ISiebTestObject

submit

public java.lang.Object submit(java.lang.String method,                                int param1,                                int param2)
Specified by:
submit in interface ISiebTestObject

submit

public java.lang.Object submit(java.lang.String method,                                java.lang.String param)
Specified by:
submit in interface ISiebTestObject

submit

public java.lang.Object submit(java.lang.String method,                                java.lang.String param1,                                java.lang.String param2)
Specified by:
submit in interface ISiebTestObject

getChildren

public TestObject[] getChildren()
Gets the immediate Siebel children of the Siebel object. References of this object must be released manually by calling one of the unregister methods after its job is done. In the recorded scripts, the unregistration happens automatically.

Overrides:
getChildren in class TestObject
Returns:
The immediate Siebel children
Since:
RFT2.1
See Also:
TestObject.unregister(), RationalTestScript.unregister(Object[]), RationalTestScript.unregisterAll(), RationalTestScript.getRegisteredTestObjects()

getChildOfName

public TestObject getChildOfName(java.lang.String repositoryName)
Gets a child object when given the Siebel repository name.

Parameters:
repositoryName - the repository name of the object
Returns:
A child object for a given Siebel repository name
Since:
RFT2.1

getChildOfUIName

public TestObject getChildOfUIName(java.lang.String UIName)
Gets the child object when given the Siebel UIName of the object.

Parameters:
UIName - the UI name (display name) of the object
Returns:
The child object for a given Siebel UI name
Since:
RFT2.1

getChildOfNameAndType

public TestObject getChildOfNameAndType(java.lang.String repositoryName,                                         java.lang.String typeName)
Gets a child object when given the Siebel repository name and classname.

Parameters:
repositoryName - the repository name of the object
typeName - the type name of the object
Returns:
A child object for a given Siebel repository name and type name
Since:
RFT2.1

getChildOfUINameAndType

public TestObject getChildOfUINameAndType(java.lang.String UIName,                                           java.lang.String typeName)
Gets a child object when given the Siebel UI name and classname.

Parameters:
UIName - UI name (display name) of the object
typeName - the type name of the object
Returns:
The child object for a given Siebel UI name and type name
Since:
RFT2.1

getChildrenOfType

public TestObject[] getChildrenOfType(java.lang.String typeName)
Gets the Siebel children when given the Siebel classname. References of this object must be released manually by calling one of the unregister methods after its job is done. In the recorded scripts, the unregistration happens automatically.

Parameters:
typeName - the Siebel classname
Returns:
The children for the given Siebel classname
Since:
RFT2.1
See Also:
TestObject.unregister(), RationalTestScript.unregister(Object[]), RationalTestScript.unregisterAll(), RationalTestScript.getRegisteredTestObjects()

getDescendantsOfName

public TestObject[] getDescendantsOfName(java.lang.String repositoryName)
Gets every Siebel descendant when given the parent and the Siebel repository name. References of this object must be released manually by calling one of the unregister methods after its job is done. In the recorded scripts, the unregistration happens automatically.

Parameters:
repositoryName - the repository name of the object
Returns:
All of the Siebel descendants
Since:
RFT2.1
See Also:
TestObject.unregister(), RationalTestScript.unregister(Object[]), RationalTestScript.unregisterAll(), RationalTestScript.getRegisteredTestObjects()

getDescendantsOfUIName

public TestObject[] getDescendantsOfUIName(java.lang.String UIName)
Gets every Siebel descendant when given the parent and the Siebel UI name. References of this object must be released manually by calling one of the unregister method after their job is done. In the recorded scripts, the unregistration happens automatically.

Parameters:
UIName - the UI name (display name) of the Siebel object
Returns:
All of the Siebel descendants when given the Siebel UI name
Since:
RFT2.1
See Also:
TestObject.unregister(), RationalTestScript.unregister(Object[]), RationalTestScript.unregisterAll(), RationalTestScript.getRegisteredTestObjects()

getDescendantsOfType

public TestObject[] getDescendantsOfType(java.lang.String typeName)
Gets every Siebel descendant when given the Siebel classname. References of this object must be released manually by calling one of the unregister method after their job is done. In the recorded scripts, the unregistration happens automatically.

Parameters:
typeName - the Siebel classname
Returns:
Every Siebel descendant when given the Siebel classname
Since:
RFT2.1
See Also:
TestObject.unregister(), RationalTestScript.unregister(Object[]), RationalTestScript.unregisterAll(), RationalTestScript.getRegisteredTestObjects()

getDescendantsOfNameAndType

public TestObject[] getDescendantsOfNameAndType(java.lang.String repositoryName,                                                 java.lang.String typeName)
Gets every Siebel descendant when given the Siebel repository name and classname. References of this object must be released manually by calling one of the unregister method after their job is done. In the recorded scripts, the unregistration happens automatically.

Parameters:
repositoryName - the repository name of the Siebel object
typeName - the Siebel classname
Returns:
Every Siebel descendant when given the Siebel repository name and classname
Since:
RFT2.1
See Also:
TestObject.unregister(), RationalTestScript.unregister(Object[]), RationalTestScript.unregisterAll(), RationalTestScript.getRegisteredTestObjects()

getDescendantsOfUINameAndType

public TestObject[] getDescendantsOfUINameAndType(java.lang.String UIName,                                                   java.lang.String typeName)
Gets every Siebel descendant when given the Siebel UI name (the display name in the user interface) and classname. References of this object must be released manually by calling one of the unregister method after their job is done. In the recorded scripts, the unregistration happens automatically.

Parameters:
UIName - the UI name (display name in the user interface) of the Siebel object
typeName - the Siebel classname
Returns:
Every Siebel descendant when given the Siebel repository name and classname
Since:
RFT2.1
See Also:
TestObject.unregister(), RationalTestScript.unregister(Object[]), RationalTestScript.unregisterAll(), RationalTestScript.getRegisteredTestObjects()

getChildren

protected static TestObject[] getChildren(TestObject parent)

getChildOfName

protected static TestObject getChildOfName(TestObject parent,                                            java.lang.String repositoryName)

getChildOfUIName

protected static TestObject getChildOfUIName(TestObject parent,                                              java.lang.String UIName)

getChildOfNameAndType

protected static TestObject getChildOfNameAndType(TestObject parent,                                                   java.lang.String repositoryName,                                                   java.lang.String typeName)

getChildOfUINameAndType

protected static TestObject getChildOfUINameAndType(TestObject parent,                                                     java.lang.String UIName,                                                     java.lang.String typeName)

getChildrenOfType

protected static TestObject[] getChildrenOfType(TestObject parent,                                                 java.lang.String typeName)

getDescendantsOfName

protected static TestObject[] getDescendantsOfName(TestObject parent,                                                    java.lang.String repositoryName)

getDescendantsOfUIName

protected static TestObject[] getDescendantsOfUIName(TestObject parent,                                                      java.lang.String UIName)

getDescendantsOfType

protected static TestObject[] getDescendantsOfType(TestObject parent,                                                    java.lang.String typeName)

getDescendantsOfNameAndType

protected static TestObject[] getDescendantsOfNameAndType(TestObject parent,                                                           java.lang.String repositoryName,                                                           java.lang.String typeName)

getDescendantsOfUINameAndType

protected static TestObject[] getDescendantsOfUINameAndType(TestObject parent,                                                             java.lang.String UIName,                                                             java.lang.String typeName)

atChild

protected static Anchor atChild(Property[] properties)

atChild

protected static Anchor atChild(java.lang.String propName,                                 java.lang.Object propValue)

atDescendant

protected static Anchor atDescendant(Property[] properties)

atDescendant

protected static Anchor atDescendant(java.lang.String propName,                                      java.lang.Object propValue)