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

Project Version 2.0

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

java.lang.Object
  extended bycom.rational.test.ft.object.interfaces.TestObject
      extended bycom.rational.test.ft.object.interfaces.GuiTestObject
          extended bycom.rational.test.ft.object.interfaces.siebel.SiebTestObject
              extended bycom.rational.test.ft.object.interfaces.siebel.SiebListTestObject
All Implemented Interfaces:
IGraphical, ISiebTestObject

public class SiebListTestObject
extends SiebTestObject

Provides script access to the SiebList.TestObject class.

Since:
RFT2.1

Field Summary
static java.lang.String CLASSNAME
           
 
Constructor Summary
SiebListTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
          For internal use.
SiebListTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
          For internal use.
SiebListTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
          For internal use.
SiebListTestObject(TestObject obj)
          Constructs one TestObject from another.
SiebListTestObject(com.rational.test.ft.object.TestObjectReference ref)
          For internal use.
 
Method Summary
 void activateRow(int rowId)
          Activates a row in the list.
 void ascendSort(java.lang.String columnName)
          Sorts the column list in ascending order.
 void clickHier()
          Toggles the active row between expanded and collapsed (for hierarchical lists).
 void descendSort(java.lang.String columnName)
          Sorts the column list in descending order.
 void drillDownColumn(java.lang.String columnName, int rowId)
          Clicks a drill-down link.
 void firstRowSet()
          Navigates to the first set of records in the list.
 java.lang.String getCellText(java.lang.String columnName, int rowNum)
          Returns the text of the specified cell.
 java.lang.String getColumnRepositoryName(java.lang.String columnName)
          Returns the repository name of the specified column.
 java.lang.String getColumnRepositoryNameByIndex(int columnName)
          Returns the RepositoryName of the specified column.
 java.lang.String getColumnSort(java.lang.String columnName)
          Returns a String indicating how the specified column is currently sorted (Ascending, Descending, or None).
 java.lang.String getColumnType(java.lang.String columnName)
          Returns the column type
 java.lang.String getColumnUIName(java.lang.String columnName)
          Returns the name of the specified column in the user interface.
 java.lang.String getTotalsValue(java.lang.String columnName)
          Returns a String indicating the value in the totals row for the specified column.
 boolean isColumnDrillDown(java.lang.String columnName)
          Returns TRUE if the specified column is a drill-down column, and FALSE if it is not.
 boolean isColumnExists(java.lang.String columnName)
          Returns a Boolean value indicating whether or not the specified column exists.
 boolean isRowExpanded(int rowId)
          Returns a Boolean value indicating whether the row is expanded (TRUE) or collapsed (FALSE).
 void lastRowSet()
          Navigates to the last set of records in the list.
 void nextRow()
          Navigates to the next row in the list.
 void nextRowSet()
          Navigates to the next set of records in the list.
 void previousRow()
          Navigates to the previous row in the list.
 void previousRowSet()
          Navigates to the previous set of records in the list.
 void selectRow(int rowNum, java.lang.String selectType)
          Activates a row in conjunction with a multi-select key (Shift or Control).
 
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
click, click, click, click, clickRadio, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getChildAtPoint, getClippedScreenRectangle, getScreenPoint, getScreenPoint, getScreenRectangle, getScreenSnapshot, 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.TestObject
equals, exists, find, find, find, findAndInvoke, findAndInvoke, findAndInvokeProxy, getDescribedObject, getDescribedObjects, getDomain, getField, getIndexer, getIndexer, getIndexers, getMappableChildren, getMappableParent, getMethods, getNameInScript, getNonValueProperties, getObjectClassName, getObjectReference, getOwnedObjects, getOwner, getParent, getProcess, getProperties, getProperty, getPropertyFromMap, getRecognitionProperties, getRecognitionPropertyWeight, getScriptCommandFlags, getStandardProperties, getTestData, getTestDataTypes, getTopMappableParent, getTopParent, invoke, invoke, invokeProxy, invokeProxy, isMappedObject, isSameObject, setIndexer, setIndexer, setProperty, toString, unregister, updateTestData, waitForExistence, waitForExistence
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASSNAME

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

SiebListTestObject

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

Since:
RFT2.1

SiebListTestObject

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

Since:
RFT2.1

SiebListTestObject

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

Since:
RFT2.1

SiebListTestObject

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

Since:
RFT2.1

SiebListTestObject

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

Since:
RFT2.1
Method Detail

nextRowSet

public void nextRowSet()
Navigates to the next set of records in the list.

Since:
RFT2.1

lastRowSet

public void lastRowSet()
Navigates to the last set of records in the list.

Since:
RFT2.1

nextRow

public void nextRow()
Navigates to the next row in the list.

Since:
RFT2.1

previousRowSet

public void previousRowSet()
Navigates to the previous set of records in the list.

Since:
RFT2.1

firstRowSet

public void firstRowSet()
Navigates to the first set of records in the list.

Since:
RFT2.1

previousRow

public void previousRow()
Navigates to the previous row in the list.

Since:
RFT2.1

clickHier

public void clickHier()
Toggles the active row between expanded and collapsed (for hierarchical lists).

Since:
RFT2.1

activateRow

public void activateRow(int rowId)
Activates a row in the list.

Parameters:
rowId - the row number to activate, based on the number of currently visible rows
Since:
RFT2.1

isRowExpanded

public boolean isRowExpanded(int rowId)
Returns a Boolean value indicating whether the row is expanded (TRUE) or collapsed (FALSE). Always returns TRUE for non-hierarchical lists.

Parameters:
rowId - the row id
Returns:
Returns true if the specified row is expanded, false if it is not expanded
Since:
RFT2.1

drillDownColumn

public void drillDownColumn(java.lang.String columnName,
                            int rowId)
Clicks a drill-down link.

Parameters:
columnName - the repository name of the column that contains the drill-down link
rowId - the row that contains the drill-down link
Since:
RFT2.1

ascendSort

public void ascendSort(java.lang.String columnName)
Sorts the column list in ascending order.

Parameters:
columnName - the repository name of the column to sort on
Since:
RFT2.1

descendSort

public void descendSort(java.lang.String columnName)
Sorts the column list in descending order.

Parameters:
columnName - the repository name of the column to sort on
Since:
RFT2.1

isColumnExists

public boolean isColumnExists(java.lang.String columnName)
Returns a Boolean value indicating whether or not the specified column exists. Returns TRUE if the specified column exists or FALSE if it does not exist

Parameters:
columnName - the repository name of the column to sort on
Returns:
Returns true if the specified column exists or false if it does not exist
Since:
RFT2.1

isColumnDrillDown

public boolean isColumnDrillDown(java.lang.String columnName)
Returns TRUE if the specified column is a drill-down column, and FALSE if it is not.

Parameters:
columnName - the repository name of the column
Returns:
Returns true if the specified column is a drill-down column, and false if it is not.
Since:
RFT2.1

getColumnRepositoryName

public java.lang.String getColumnRepositoryName(java.lang.String columnName)
Returns the repository name of the specified column.

Parameters:
columnName - the column name
Returns:
The repository name of the specified column
Since:
RFT2.1

getColumnUIName

public java.lang.String getColumnUIName(java.lang.String columnName)
Returns the name of the specified column in the user interface.

Parameters:
columnName - the column name
Returns:
- The name of the specified column in the user interface
Since:
RFT2.1

getColumnType

public java.lang.String getColumnType(java.lang.String columnName)
Returns the column type

Parameters:
columnName - the column name
Returns:
The column type
Since:
RFT2.1

getColumnRepositoryNameByIndex

public java.lang.String getColumnRepositoryNameByIndex(int columnName)
Returns the RepositoryName of the specified column.

Parameters:
columnName - the column name
Returns:
The RepositoryNameSince:
RFT2.1

getColumnSort

public java.lang.String getColumnSort(java.lang.String columnName)
Returns a String indicating how the specified column is currently sorted (Ascending, Descending, or None).

Parameters:
columnName - the column name
Returns:
A String indicating how the specified column is currently sorted (Ascending, Descending, or None)
Since:
RFT2.1

selectRow

public void selectRow(int rowNum,
                      java.lang.String selectType)
Activates a row in conjunction with a multi-select key (Shift or Control).

Parameters:
rowNum - the number of the activated row
selectType - the multi-select key (Shift or Control) that is used. If SelectType is not defined, no multiselect key is used
Since:
RFT2.1

getCellText

public java.lang.String getCellText(java.lang.String columnName,
                                    int rowNum)
Returns the text of the specified cell.

Parameters:
columnName - the column name
rowNum - the number of the row activated
Returns:
The text of the specified cell
Since:
RFT2.1

getTotalsValue

public java.lang.String getTotalsValue(java.lang.String columnName)
Returns a String indicating the value in the totals row for the specified column. Returns an empty String if the column does not have a totals row.

Parameters:
columnName - the name of the column
Returns:
Returns a String indicating the value in the totals row for the specified column. Returns an empty String if the column does not have a totals row.
Since:
RFT2.1