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 IProxyBase

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 IProxyBase

These methods are implemented by all proxies, and may be called from any Channel. In particular, they may be called from the base channel.

Since:
RFT1.1

Method Summary
 TestDomainImplementation getTestDomain()
          Returns the TestDomain that this proxy object is associated with.
 java.lang.String getTestObjectClassName()
          Returns a valid class name specification.
 boolean isValidObject()
          Returns true if the underlying object is still valid.
 

Method Detail

getTestDomain

TestDomainImplementation getTestDomain()
Returns the TestDomain that this proxy object is associated with.

Returns:
The associated TestDomain class full name.
Since:
RFT1.0

getTestObjectClassName

java.lang.String getTestObjectClassName()
Returns a valid class name specification. The test script (which runs in a separate process) interacts with a class that supports a shared interface with a specific proxy. This class is called a TestObject class. The testObject performs a cross-process (and cross-JVM) call to the same method against an associated proxy, which is this proxy.

This method should never return null, even if shouldBeMapped() returns false. User may still access objects such as this through scripting method calls and can return references to them. If a null were returned, the marshalling code would be confused and would not be able to construct a test object.

This method may be called from any thread.

Returns:
The associated testObject class full name.
Since:
RFT1.0

isValidObject

boolean isValidObject()
Returns true if the underlying object is still valid. This method is called by the framework when the proxy is being invoked through reflection. In some domains, the proxies access to the underlying object may not be guaranteed, but there may be some checks that could be used to safeguard the proxy. For example, in Microsoft Windows, a proxy that wrapped an HWND-based object might want to validate that the HWND was still correct. It might do this by checking the window classname, the thread to which the window belongs, and the validity of the window handle itself. The default implementation just returns true. If this returns false, subsequent calls to the object may be blocked.

Returns:
true if the underlying object is valid.
Since:
RFT1.1