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 SiebList.TestObject class.

Since:
RFT1.0

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)
          ActivateRow (RowNumber) Activates a row in the list.
 void ascendSort(java.lang.String columnName)
          AscendSort (ColumnRepName) Sorts the list on the column in ascending order.
 void clickHier()
          ClickHier Toggles the active row between expanded and collapsed (for hierarchical lists).
 void descendSort(java.lang.String columnName)
          DescendSort (ColumnRepName) Sorts the list on the column in descending order.
 void drillDownColumn(java.lang.String columnName, int rowId)
          DrillDownColumn (ColumnRepName, RowNumber) Clicks a drilldown link.
 void firstRowSet()
          FirstRowSet Navigates to the first set of records in the list.
 java.lang.String getCellText(java.lang.String columnName, int rowNum)
          String GetCellText (ColumnRepName, RowNumber) Returns the text of the specified cell.
 java.lang.String getColumnRepositoryName(java.lang.String columnName)
          String GetColumnRepositoryName (ColumnUIName) Returns the RepositoryName of the specified column.
 java.lang.String getColumnRepositoryNameByIndex(int columnName)
          String GetColumnRepositoryNameByIndex (ColumnIndex) Returns the RepositoryName of the specified column.
 java.lang.String getColumnSort(java.lang.String columnName)
          String GetColumnSort (ColumnRepName) Returns a String indicating how the specified column is currently sorted (Ascend or Descend or None).
 java.lang.String getColumnType(java.lang.String columnName)
           
 java.lang.String getColumnUIName(java.lang.String columnName)
          String GetColumnUIName (ColumnRepName) Returns the UIName of the specified column.
 java.lang.String getTotalsValue(java.lang.String columnName)
          String GetTotalsValue (ColumnRepName) Returns a String indicating the value in the totals row for the specified column.
 boolean isColumnDrillDown(java.lang.String columnName)
          Boolean IsColumnDrilldown (ColumnRepName) Returns TRUE if the specified column is a drilldown column, and FALSE if it is not.
 boolean isColumnExists(java.lang.String columnName)
          Boolean IsColumnExists (ColumnRepName) Returns a Boolean value indicating whether or not the specified column exists.
 boolean isRowExpanded(int rowId)
          Boolean IsRowExpanded (RowNumber) Returns a Boolean value indicating whether the row is expanded (TRUE) or collapsed (FALSE).
 void lastRowSet()
          LastRowSet Navigates to the last set of records in the list.
 void nextRow()
          NextRow Navigates to the next row in the list.
 void nextRowSet()
          NextRowSet Navigates to the next set of records in the list.
 void previousRow()
          PreviousRow Navigates to the previous row in the list.
 void previousRowSet()
          PrevRowSet Navigates to the previous set of records in the list.
 void selectRow(int rowNum, java.lang.String selectType)
          SelectRow (RowNumber, SelectType) Activates a row in conjunction with a multiselect key.
 
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:
RFT1.0

SiebListTestObject

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

Since:
RFT1.0

SiebListTestObject

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

Since:
RFT1.0

SiebListTestObject

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

Since:
RFT1.0

SiebListTestObject

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

Since:
RFT1.0
Method Detail

nextRowSet

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

Since:
RFT1.0

lastRowSet

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

Since:
RFT1.0

nextRow

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

Since:
RFT1.0

previousRowSet

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

Since:
RFT1.0

firstRowSet

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

Since:
RFT1.0

previousRow

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

Since:
RFT1.0

clickHier

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

Since:
RFT1.0

activateRow

public void activateRow(int rowId)
ActivateRow (RowNumber) Activates a row in the list. RowNumber is an Integer that indicates which row to activate, based on the number of currently visible rows.

Since:
RFT1.0

isRowExpanded

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

Since:
RFT1.0

drillDownColumn

public void drillDownColumn(java.lang.String columnName,
                            int rowId)
DrillDownColumn (ColumnRepName, RowNumber) Clicks a drilldown link. ColumnRepName = the RepositoryName of the column that contains the drilldown link. RowNumber = the row that contains the drilldown link.

Since:
RFT1.0

ascendSort

public void ascendSort(java.lang.String columnName)
AscendSort (ColumnRepName) Sorts the list on the column in ascending order. ColumnRepName is a String that indicates the RepositoryName of the column to sort on.

Since:
RFT1.0

descendSort

public void descendSort(java.lang.String columnName)
DescendSort (ColumnRepName) Sorts the list on the column in descending order. ColumnRepName is a String that indicates the RepositoryName of the column to sort on.

Since:
RFT1.0

isColumnExists

public boolean isColumnExists(java.lang.String columnName)
Boolean IsColumnExists (ColumnRepName) Returns a Boolean value indicating whether or not the specified column exists.

Since:
RFT1.0

isColumnDrillDown

public boolean isColumnDrillDown(java.lang.String columnName)
Boolean IsColumnDrilldown (ColumnRepName) Returns TRUE if the specified column is a drilldown column, and FALSE if it is not. ColumnRepName is a String that indicates the RepositoryName of the column.

Since:
RFT1.0

getColumnRepositoryName

public java.lang.String getColumnRepositoryName(java.lang.String columnName)
String GetColumnRepositoryName (ColumnUIName) Returns the RepositoryName of the specified column.

Since:
RFT1.0

getColumnUIName

public java.lang.String getColumnUIName(java.lang.String columnName)
String GetColumnUIName (ColumnRepName) Returns the UIName of the specified column.

Since:
RFT1.0

getColumnType

public java.lang.String getColumnType(java.lang.String columnName)
Since:
RFT1.0

getColumnRepositoryNameByIndex

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

Since:
RFT1.0

getColumnSort

public java.lang.String getColumnSort(java.lang.String columnName)
String GetColumnSort (ColumnRepName) Returns a String indicating how the specified column is currently sorted (Ascend or Descend or None).

Since:
RFT1.0

selectRow

public void selectRow(int rowNum,
                      java.lang.String selectType)
SelectRow (RowNumber, SelectType) Activates a row in conjunction with a multiselect key. RowNumber = the number of the row activated; SelectType = the multiselect key (Shift or Control) that is used. If SelectType is not defined, no multiselect key is used.

Since:
RFT1.0

getCellText

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

Since:
RFT1.0

getTotalsValue

public java.lang.String getTotalsValue(java.lang.String columnName)
String GetTotalsValue (ColumnRepName) 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:
RFT1.0