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 SiebApplicationTestObject

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
                  extended by com.rational.test.ft.object.interfaces.siebel.SiebApplicationTestObject
All Implemented Interfaces:
IGraphical, ISiebTestObject

public class SiebApplicationTestObject
extends SiebTestObject

Provides script access to the SiebApplication.TestObject class.

Since:
RFT2.1

Field Summary
static java.lang.String CLASSNAME
           
 
Fields inherited from class com.rational.test.ft.object.interfaces.TestObject
ref
 
Constructor Summary
SiebApplicationTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
          For internal use.
SiebApplicationTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
          For internal use.
SiebApplicationTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
          For internal use.
SiebApplicationTestObject(TestObject obj)
          Constructs one TestObject from another.
SiebApplicationTestObject(com.rational.test.ft.object.TestObjectReference ref)
          For internal use.
 
Method Summary
 int getBusyTime()
          Returns the time (in milliseconds) that it took the Siebel Application Client to become idle when the Siebel Application UI changed from standard to high interactivity.
 int getClassCount(java.lang.String className)
          Returns the number of objects of a specified object type by using the class name of that particular object.
 int getLastErrorCode()
          Returns the error code issued for the last operation.
 java.lang.String getLastErrorMessage()
          Returns the last error message issued.
 java.lang.String getLastOpId()
          Returns the ID of the last operation.
 int getLastOpTime()
          Returns the time (in milliseconds) that it took to execute the previous operation.
 SiebMenuTestObject getMenuItem(java.lang.String repositoryName)
          Returns the menu item when given the repository name of the object.
 SiebMenuTestObjectDictionary getMenuItems()
          Returns the collection of available menu items.
 java.lang.String getRepositoryName(java.lang.String className, java.lang.String uIName)
          Returns the RepositoryName of the object when given the classname and UI name (name in the user interface).
 java.lang.String getRepositoryNameByIndex(java.lang.String className, int index)
          Returns the repository name of the object for a given classname and index of the object.
 SiebScreenTestObject getScreen(java.lang.String repositoryName)
          Returns a screen when given the repository name of the object.
 SiebScreenTestObjectDictionary getScreens()
          Returns a collection of available screens.
 java.lang.String getSessionId()
          Returns the ID of the current session.
static SiebApplicationTestObject getSiebelApplication(java.lang.String applicationName)
          Returns the Siebel application test object for the specified application name.
 SiebPageTabsTestObject getTabPage()
          Returns the available tab page object.
 SiebToolbarTestObject getToolbar(java.lang.String repositoryName)
          Returns a toolbar when given the name of a repository.
 SiebToolbarTestObjectDictionary getToolbars()
          Returns a collection of available toolbars
 void processKeyboardAccelerator(java.lang.String keys)
          Executes the keyboard accelerators.
 int setTimeOut(int newTimeOutInSecs)
          Sets the maximum time (in seconds) that the test tool waits for the application to return from an operation before executing the next line of a script.
 void sync()
          Synchronizes the automation framework with the Siebel application.
 
Methods inherited from class com.rational.test.ft.object.interfaces.siebel.SiebTestObject
atChild, atChild, atDescendant, atDescendant, getChildOfName, getChildOfName, getChildOfNameAndType, getChildOfNameAndType, getChildOfUIName, getChildOfUIName, getChildOfUINameAndType, getChildOfUINameAndType, getChildren, getChildren, getChildrenOfType, getChildrenOfType, getDescendantsOfName, getDescendantsOfName, getDescendantsOfNameAndType, getDescendantsOfNameAndType, getDescendantsOfType, getDescendantsOfType, getDescendantsOfUIName, getDescendantsOfUIName, getDescendantsOfUINameAndType, getDescendantsOfUINameAndType, submit, submit, submit, submit, submit, submit
 
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
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME
See Also:
Constant Field Values
Constructor Detail

SiebApplicationTestObject

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

Since:
RFT2.1

SiebApplicationTestObject

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

Since:
RFT2.1

SiebApplicationTestObject

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

Since:
RFT2.1

SiebApplicationTestObject

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

Since:
RFT2.1

SiebApplicationTestObject

public SiebApplicationTestObject(TestObject obj)
Constructs one TestObject from another. Both are references to the same object. A TestObject provides access to objects in the software under test.

Since:
RFT2.1
Method Detail

processKeyboardAccelerator

public void processKeyboardAccelerator(java.lang.String keys)
Executes the keyboard accelerators.

Parameters:
keys - string that specifies the accelerator keys to execute (for example, F9 or Ctrl-Shift-K). *
Since:
RFT2.1

sync

public void sync()
Synchronizes the automation framework with the Siebel application.

Since:
RFT2.1

getClassCount

public int getClassCount(java.lang.String className)
Returns the number of objects of a specified object type by using the class name of that particular object.

Parameters:
className - the class of the object
Returns:
The number of objects of the specified type
Since:
RFT2.1

getRepositoryNameByIndex

public java.lang.String getRepositoryNameByIndex(java.lang.String className,                                                  int index)
Returns the repository name of the object for a given classname and index of the object.

Parameters:
className - the class of the object
index - the index (starting at zero) of the object in the value returned from the GetClassCount method.
Returns:
The name of the object in the repository
Since:
RFT2.1

getRepositoryName

public java.lang.String getRepositoryName(java.lang.String className,                                           java.lang.String uIName)
Returns the RepositoryName of the object when given the classname and UI name (name in the user interface).

Parameters:
className - the class of the object
uIName - the name of the object in the user interface
Returns:
The name of the object in the repository
Since:
RFT2.1

getLastErrorCode

public int getLastErrorCode()
Returns the error code issued for the last operation.

Returns:
The last error code issued
Since:
RFT2.1

getLastErrorMessage

public java.lang.String getLastErrorMessage()
Returns the last error message issued.

Returns:
The last error message issued
Since:
RFT2.1

setTimeOut

public int setTimeOut(int newTimeOutInSecs)
Sets the maximum time (in seconds) that the test tool waits for the application to return from an operation before executing the next line of a script. When maximum time is exceeded, the test tool halts the script and displays an error.

Parameters:
newTimeOutInSecs - the new time out in seconds
Returns:
Returns the previously set time out value (in seconds) on successful execution.
Since:
RFT2.1

getLastOpTime

public int getLastOpTime()
Returns the time (in milliseconds) that it took to execute the previous operation.

Returns:
The time (in milliseconds) that it took to execute the previous operation.
Since:
RFT2.1

getBusyTime

public int getBusyTime()
Returns the time (in milliseconds) that it took the Siebel Application Client to become idle when the Siebel Application UI changed from standard to high interactivity.

Returns:
The time (in milliseconds) that it took the Siebel Application Client to become idle when the Siebel Application UI changed from standard to high interactivity.
Since:
RFT2.1

getLastOpId

public java.lang.String getLastOpId()
Returns the ID of the last operation.

Returns:
The ID of the last operation.
Since:
RFT2.1

getSessionId

public java.lang.String getSessionId()
Returns the ID of the current session.

Returns:
The ID of the current session.
Since:
RFT2.1

getSiebelApplication

public static SiebApplicationTestObject getSiebelApplication(java.lang.String applicationName)
Returns the Siebel application test object for the specified application name.

Parameters:
applicationName - the name of the application
Returns:
The Siebel application test object for the specified name
Since:
RFT2.1

getScreen

public SiebScreenTestObject getScreen(java.lang.String repositoryName)
Returns a screen when given the repository name of the object.

Parameters:
repositoryName - the name of the repository
Returns:
A screen with the given name
Since:
RFT2.1

getScreens

public SiebScreenTestObjectDictionary getScreens()
Returns a collection of available screens.

Returns:
A collection of available screens.
Since:
RFT2.1

getToolbar

public SiebToolbarTestObject getToolbar(java.lang.String repositoryName)
Returns a toolbar when given the name of a repository.

Parameters:
repositoryName - the name of the repository
Returns:
The toolbar returned from the repository
Since:
RFT2.1

getToolbars

public SiebToolbarTestObjectDictionary getToolbars()
Returns a collection of available toolbars

Returns:
A collection of available toolbars.
Since:
RFT2.1

getMenuItem

public SiebMenuTestObject getMenuItem(java.lang.String repositoryName)
Returns the menu item when given the repository name of the object.

Parameters:
repositoryName - the name of the repository
Returns:
The menu item returned from the named repository.
Since:
RFT2.1

getMenuItems

public SiebMenuTestObjectDictionary getMenuItems()
Returns the collection of available menu items.

Returns:
The collection of available menu items
Since:
RFT2.1

getTabPage

public SiebPageTabsTestObject getTabPage()
Returns the available tab page object.

Returns:
The available tab page object
Since:
RFT2.1