IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester Proxy SDK Reference

Project Version 2.3

com.rational.test.ft.domain
Interface IDataDriven

All Known Implementing Classes:
AbstractButtonProxy, AppletHostProxy, AppletProxy, AppletViewerProxy, AppletViewerProxy.AppletWrapperProxy, ButtonProxy, ButtonProxy, CanvasProxy, CComboProxy, CheckboxMenuItemProxy, CheckboxProxy, ChoiceProxy, CLabelProxy, ColorDialogProxy, ComboListBoxProxy, ComboProxy, ComponentProxy, CompositeProxy, ControlProxy, CoolBarProxy, CoolItemProxy, CTabFolderProxy, CTabItemProxy, DescribedObject, DescribedObjectReference, DialogProxy, DirectoryDialogProxy, DomainProxy, EmbeddedShellProxy, FileDialogProxy, FileDialogProxy, FrameProxy, GroupProxy, InternalFrameTitlePaneProxy, ItemProxy, JavaDomainProxy, JavaGuiProxy, JavaProxy, JCheckBoxProxy, JComboBoxProxy, JComponentProxy, JDesktopIconProxy, JDesktopProxy, JDialogProxy, JfcGraphicalSubitemProxy, JFrameProxy, JInternalFrameProxy, JLabelProxy, JListProxy, JMenuBarProxy, JMenuItemProxy, JMenuProxy, JOptionPaneProxy, JPanelProxy, JPopupMenuProxy, JPopupMenuWindowProxy, JProgressBarProxy, JScrollBarProxy, JScrollPaneProxy, JSeparatorProxy, JSliderProxy, JSplitPaneProxy, JTabbedPaneProxy, JTableHeaderProxy, JTableProxy, JTextProxy, JToolBarProxy, JToolTipProxy, JTreeProxy, JWindowProxy, LabelProxy, LabelProxy, ListProxy, ListProxy, MenuBarProxy, MenuComponentProxy, MenuItemProxy, MenuItemProxy, MenuProxy, MenuProxy, MessageBoxProxy, PanelProxy, PopupMenuProxy, ProcessDomainProxy, ProxyTestObject, PseudoTopLevelProxy, SashFormProxy, SashProxy, ScaleProxy, ScrollableProxy, ScrollableSwtGraphicalSubitemProxy, ScrollbarProxy, ScrollBarProxy, ScrollPaneProxy, ShellProxy, SiebelTableProxy, SliderProxy, SpinnerProxy, SwtGraphicalSubitemProxy, SwtProxy, TabFolderProxy, TableProxy, TableTreeProxy, TextAreaProxy, TextProxy, ToolBarProxy, ToolItemProxy, TopLevelWindowProxy, TopLevelWindowProxy, TreeProxy, ViewFormProxy, WidgetProxy, WindowProxy

public interface IDataDriven


Field Summary
static int INCLUDE_ALL
          Flag to include the top proxy and all decendents with data drivable commands.
static int INCLUDE_JUSTOBJECT
          Flag to include only the one proxy as a data drivable command.
static int INCLUDE_SIBLINGS
          Flag to include the top proxy and all immediate children with data drivable commands.
 
Method Summary
 com.rational.test.ft.sys.MethodSpecification getDataDrivableCommand()
          This method must be implemented by any proxy that wishes to support data driving.
 com.rational.test.ft.sys.MethodSpecification[] getDataDrivableCommands(int includeChildren)
          Walks the proxy parent-child hierarchy and returns a command for each control that is data drivable.
 

Field Detail

INCLUDE_JUSTOBJECT

static final int INCLUDE_JUSTOBJECT
Flag to include only the one proxy as a data drivable command.

Since:
RFT2.0
See Also:
Constant Field Values

INCLUDE_SIBLINGS

static final int INCLUDE_SIBLINGS
Flag to include the top proxy and all immediate children with data drivable commands.

Since:
RFT2.0
See Also:
Constant Field Values

INCLUDE_ALL

static final int INCLUDE_ALL
Flag to include the top proxy and all decendents with data drivable commands.

Since:
RFT2.0
See Also:
Constant Field Values
Method Detail

getDataDrivableCommands

com.rational.test.ft.sys.MethodSpecification[] getDataDrivableCommands(int includeChildren)
Walks the proxy parent-child hierarchy and returns a command for each control that is data drivable. Controls that are not data drivable and do not have children that are data drivable should return null.

The reason that the proxies are left with doing the walk instead of it happening at a higher level is because they have a better understanding of the hierarchy they expose. Domains like HTML can take advantage of internal knowledge to allow them better control the traversal of interesting child proxies relative to data driving. By default this method will perform a standard traversal of the proxy hierarchy and does not need to be overridden unless necessary.

Parameters:
includeChildren - Flag to control which child objects are considered for data driving. Must be INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS or INCLUDE_ALL.
Returns:
An array of commands that can be data driven.
Since:
RFT2.0
See Also:
getDataDrivableCommand()

getDataDrivableCommand

com.rational.test.ft.sys.MethodSpecification getDataDrivableCommand()
This method must be implemented by any proxy that wishes to support data driving. By default a null value is returned.

Since:
RFT2.0
See Also:
getDataDrivableCommands(int)