org.safs.tools

Interface RuntimeDataInterface

All Known Subinterfaces:

CoreInterface

All Known Implementing Classes:

AutoItComponent, AutoItComponent.AutoItDriverCommand, AutoItComponent.CFComponent, CFButton, CFCheckBox, CFCheckBox, CFCheckBox, CFCheckBoxFunctions, CFComboBox, CFComboBox, CFComboBox, CFComboBoxFunctions, CFComponent, CFComponent, CFComponent, CFComponent, CFComponentFunctions, CFDatabase, CFDatePickerFunctions, CFDefaultComponent, CFDotNetMenuBar, CFDotNetPopupMenu, CFDotnetTable, CFDotNetTree, CFEditBox, CFEditBox, CFEditBox, CFEditTextFunctions, CFFlexColor, CFFlexComboBox, CFFlexDate, CFFlexList, CFFlexList, CFFlexMenuBar, CFFlexMenuBar, CFFlexNumericStepper, CFFlexPageTabList, CFFlexSlider, CFFlexTable, CFFlexTree, CFFlexTree, CFHtmlDocument, CFHTMLDocument, CFHtmlImage, CFHtmlLink, CFHtmlTable, CFHTMLTable, CFJCTable, CFJCTreeTable, CFLabel, CFList, CFList, CFListBox, CFListView, CFListViewFunctions, CFMenuBar, CFMenuBar, CFPageTabList, CFPopupMenu, CFProgressBarFunctions, CFScrollBar, CFScrollBar, CFScrollBarFunctions, CFTabControl, CFTabControlFunctions, CFTable, CFTable, CFText, CFTIDComponent, CFTimePickerFunctions, CFToolBar, CFTree, CFTree, CFViewFunctions, CFWindow, CFWinMenuBar, CFWinPageTabList, CFWinPopupMenu, CFWPFComboBox, CFWPFLabel, CFWPFList, CFWPFMenuBar, CFWPFPageTabList, CFWPFPopupMenu, CFWPFSlider, CFWPFText, CFWPFTree, ComponentFunction, DCDriverCommand, DCDriverCommand, DCDriverCommand, DCDriverCommand, DCDriverDatabaseCommands, DCDriverFileCommands, DCDriverFlowCommands, DCDriverMiscCommands, DCDriverStringCommands, DCDriverTimerCommands, DDriverCommand, DEngineCommandProcessor, DriverCommand, DriverCommandProcessor, DTestStepProcessor, EmbeddedHookSTAFHelper, EngineCommandProcessor, GenericEngine, IDriverCommand, ITestStepProcessor, JVMAgentTestStepProcessor, Processor, REngineCommandProcessor, SAFSABBOT, SAFSDRIVERCOMMANDS, SAFSDROID, SAFSIOS, SAFSQTP, SAFSROBOTJ, SAFSSELENIUM, SAFSTC, SingletonSTAFHelper, STAFHelper, TestStepProcessor, TIDComponent, TIDComponent.CFComponent, TIDComponent.RESTComponent, TIDDriverCommands, TIDDriverCounterCommands, TIDDriverFlowCommands, TIDDriverLogCommands, TIDDriverRestCommands, TIDDriverRestCommands.RESTDriverCommand, WDTestStepProcessor

public interface RuntimeDataInterface

Classes implementing this Interface are providing access to various assets provided by the running test framework. For example, access to global variables and App Map items.

Author:

Carl Nagle

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAppMapItem(java.lang.String appMapId, java.lang.String sectionName, java.lang.String itemName) Retrieve the resolved value of an item stored in the App Map chain (SAFSMAPS).
java.lang.String	getVariable(java.lang.String varName) Retrieve the current runtime value of the global variable (SAFSVARS).
boolean	setVariable(java.lang.String varName, java.lang.String varValue) Set a new runtime value of a global variable (SAFSVARS).

Method Detail

getVariable

java.lang.String getVariable(java.lang.String varName)
                      throws SAFSException

Retrieve the current runtime value of the global variable (SAFSVARS).

Parameters:

varName - -- Variable names are NOT case-sensitive.

Returns:

String value which can be a zero-length value. null if no such item was found or some type of error occurred during execution.

Throws:

SAFSException

setVariable

boolean setVariable(java.lang.String varName,
                    java.lang.String varValue)
             throws SAFSException

Set a new runtime value of a global variable (SAFSVARS).

Parameters:

varName - -- Variable names are NOT case-sensitive.

varValue - -- value to set. Can be an empty string.

Returns:

value of the variable after it has been set. can be null if the set was not successful or some other error occurred.

Throws:

SAFSException

getAppMapItem

java.lang.String getAppMapItem(java.lang.String appMapId,
                               java.lang.String sectionName,
                               java.lang.String itemName)
                        throws SAFSException

Retrieve the resolved value of an item stored in the App Map chain (SAFSMAPS).

Parameters:

appMapId - -- can be null to get from the "default/current" app map.

sectionName - -- section names are NOT case-sensitive.

itemName - -- item names are NOT case-sensitive.

Returns:

String value which can be a zero-length value. null if no such item was found or some type of error occurred during execution.

Throws:

SAFSException