org.safs.android.remotecontrol

Class SAFSEngineCommands

java.lang.Object

com.jayway.android.robotium.remotecontrol.solo.SoloWorker

com.jayway.android.robotium.remotecontrol.solo.Solo

org.safs.android.remotecontrol.SAFSWorker

org.safs.android.remotecontrol.SAFSEngineCommands

All Implemented Interfaces:

DebugListener, NamedListener

public class SAFSEngineCommands
extends SAFSWorker

Provide an Android RemoteControl API interface to SAFS Engine Commands for non-SAFS users using a SAFSTestRunner.

Default usage:

 Instantiate *and* initialize Solo API object according to the Solo class, then:
 
 SAFSEngineCommands engine = new SAFSEngineCommands(solo);
 (use the API)
 

Note: SAFSEngineCommands can use component UID references that have been acquired from either the remote control Solo class APIs or the SAFSEngineCommands APIs.

Author:

Carl Nagle, SAS Institute, Inc.

See Also:

SoloTest

Field Summary

Fields inherited from class com.jayway.android.robotium.remotecontrol.solo.Solo

_last_remote_result, androidsdk, CLOSED, DELETE, DOWN, ENTER, LANDSCAPE, LEFT, MENU, OPENED, PORTRAIT, RIGHT, UP

Fields inherited from class com.jayway.android.robotium.remotecontrol.solo.SoloWorker

_props, CAUSE_SEP, control, default_connect_stimeout, default_ready_stimeout, default_result_stimeout, default_running_stimeout, default_shutdown_stimeout, doProcessFailure, doProcessSuccess, err, FAIL_SUFFIX, listenername, log, out, PASS_SUFFIX, tcp_delay

Constructor Summary

Constructors

Constructor and Description
SAFSEngineCommands(Solo solo) Default (required) public constructor.

Method Summary

Modifier and Type	Method and Description
void	clearHighlightedDialog() ClearHighlightedDialog
void	clearReferenceCache() ClearReferenceCache
java.lang.String	getAccessibleName(java.lang.String uID) GetAccessibleName
java.lang.String	getCaption(java.lang.String uID) GetCaption
int	getChildCount(java.lang.String uID) GetChildCount
java.lang.String[]	getChildren(java.lang.String uID) GetChildren
int	getClassIndex(java.lang.String uID) GetClassIndex
java.lang.String	getClassname(java.lang.String uID) GetClassname
java.lang.String	getCurrentWindow() GetCurrentWindow
java.lang.String	getId(java.lang.String uID) GetId
java.lang.String	getMatchingChildObjects(java.lang.String parentUID, java.lang.String recognition) GetMatchingChildObjects
java.lang.String	getMatchingParentObject(java.lang.String recognition) GetMatchingParentObject
java.lang.String	getName(java.lang.String uID) GetName
java.lang.String	getNonAccessibleName(java.lang.String uID) GetNonAccessibleName
java.lang.String	getProperty(java.lang.String uID, java.lang.String propertyName) GetProperty
java.lang.String[]	getPropertyNames(java.lang.String uID) GetPropertyNames
java.lang.String[]	getSuperclassNames(java.lang.String uID) GetSuperClassnames
java.lang.String	getText(java.lang.String uID) GetText
int	getTopLevelCount() GetTopLevelCount
java.lang.String[]	getTopLevelWindows() GetTopLevelWindows
void	highlightMatchingChildObjectByKey(java.lang.String parentUID, java.lang.String childUID) HighlightMatchingChildObjectByKey
boolean	isEnabled(java.lang.String uID) IsEnabled
boolean	isShowing(java.lang.String uID) IsShowing
boolean	isTopLevelPopupContainer(java.lang.String uID) IsTopLevelPopupContainer
boolean	isValid(java.lang.String uID) IsValid
void	setActiveWindow(java.lang.String uID) SetActiveWindow

Methods inherited from class org.safs.android.remotecontrol.SAFSWorker

createRemoteControl, getListenerName

Methods inherited from class com.jayway.android.robotium.remotecontrol.solo.Solo

assertCurrentActivityClass, assertCurrentActivityClass, assertCurrentActivityName, assertCurrentActivityName, assertMemoryNotLow, clearEditText, clearEditText, clearLog, clearTextInWebElement, clickInList, clickInList, clickLongInList, clickLongInList, clickLongInList, clickLongOnScreen, clickLongOnScreen, clickLongOnText, clickLongOnText, clickLongOnText, clickLongOnText, clickLongOnTextAndPress, clickLongOnView, clickLongOnView, clickOnActionBarHomeButton, clickOnActionBarItem, clickOnButton, clickOnButton, clickOnCheckBox, clickOnEditText, clickOnImage, clickOnImageButton, clickOnMenuItem, clickOnMenuItem, clickOnRadioButton, clickOnScreen, clickOnScreen, clickOnText, clickOnText, clickOnText, clickOnToggleButton, clickOnView, clickOnView, clickOnWebElement, clickOnWebElement, clickOnWebElement, clickOnWebElement, drag, enterText, enterText, enterTextInWebElement, finalizeRemoteSolo, finishOpenedActivities, getActivityMonitor, getAllOpenActivities, getButton, getButton, getButton, getCurrentActivity, getCurrentButtons, getCurrentCheckBoxes, getCurrentDatePickers, getCurrentEditTexts, getCurrentGridViews, getCurrentImageButtons, getCurrentImageViews, getCurrentListViews, getCurrentNumberPickers, getCurrentProgressBars, getCurrentRadioButtons, getCurrentScrollViews, getCurrentSlidingDrawers, getCurrentSpinners, getCurrentTextViews, getCurrentTimePickers, getCurrentToggleButtons, getCurrentViews, getCurrentViews, getCurrentViews, getCurrentViews, getCurrentViews, getCurrentWebElements, getCurrentWebElements, getEditText, getEditText, getEditText, getGUIImage, getImage, getImageButton, getObjectClassName, getScreenshotSequence, getScreenshotSequence, getScreenshotSequenceSize, getScreenSize, getString, getString, getTagForView, getText, getText, getTextViewValue, getTopParent, getView, getView, getView, getViewByName, getViewByName, getViewByTag, getViewByTag, getViewClassName, getViewLocation, getViews, getViews, getWebElement, getWebElements, getWebElements, getWebUrl, goBack, goBackToActivity, hideSoftKeyboard, isCheckBoxChecked, isCheckBoxChecked, isRadioButtonChecked, isRadioButtonChecked, isSpinnerTextSelected, isSpinnerTextSelected, isTextChecked, isToggleButtonChecked, isToggleButtonChecked, pinchToZoom, pressMenuItem, pressMenuItem, pressSoftKeyboardNextButton, pressSoftKeyboardSearchButton, pressSpinnerItem, rotateLarge, rotateSmall, scrollDown, scrollDownList, scrollDownListUID, scrollListToBottom, scrollListToBottomUID, scrollListToLine, scrollListToLineUID, scrollListToTop, scrollListToTopUID, scrollToBottom, scrollToSide, scrollToSide, scrollToSide, scrollToTop, scrollUp, scrollUpList, scrollUpListUID, scrollViewToSide, scrollViewToSide, scrollViewToSide, searchButton, searchButton, searchButton, searchButton, searchEditText, searchText, searchText, searchText, searchText, searchText, searchToggleButton, searchToggleButton, sendKey, setActivityOrientation, setDatePicker, setDatePicker, setMobileData, setNavigationDrawer, setProgressBar, setProgressBar, setSlidingDrawer, setSlidingDrawer, setTimePicker, setTimePicker, setWiFiData, sleep, startMainLauncher, startScreenshotSequence, startScreenshotSequence, stopScreenshotSequence, swipe, takeScreenshot, takeScreenshot, takeScreenshot, typeText, typeText, typeTextInWebElement, typeTextInWebElement, typeTextInWebElement, unlockScreen, waitForActivity, waitForActivity, waitForActivityByClass, waitForActivityByClass, waitForCondition, waitForDialogToClose, waitForDialogToClose, waitForDialogToOpen, waitForDialogToOpen, waitForEmptyActivityStack, waitForFragmentById, waitForFragmentByTag, waitForLogMessage, waitForText, waitForText, waitForText, waitForText, waitForView, waitForView, waitForView, waitForView, waitForView, waitForView, waitForViewByTag, waitForViewByTag, waitForViewByTag, waitForViewUID, waitForViewUID, waitForWebElement, waitForWebElement, waitForWebElement

Methods inherited from class com.jayway.android.robotium.remotecontrol.solo.SoloWorker

debug, getRemoteControl, initialize, onReceiveDebug, prepInstrumentDispatch, prepSoloDispatch, processFailure, processSuccess, setControllerPort, setLogsInterface, setPortForwarding, setRemoteControl, shutdown, shutdownRemote, turnProtocolDebug, turnRunnerDebug

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SAFSEngineCommands

public SAFSEngineCommands(Solo solo)

Default (required) public constructor.

Parameters:

solo - Solo instance already created and initialized.

Method Detail

clearHighlightedDialog

public void clearHighlightedDialog()
                            throws java.lang.IllegalThreadStateException,
                                   RemoteException,
                                   java.util.concurrent.TimeoutException,
                                   ShutdownInvocationException

ClearHighlightedDialog

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

clearReferenceCache

public void clearReferenceCache()
                         throws java.lang.IllegalThreadStateException,
                                RemoteException,
                                java.util.concurrent.TimeoutException,
                                ShutdownInvocationException

ClearReferenceCache

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getAccessibleName

public java.lang.String getAccessibleName(java.lang.String uID)
                                   throws java.lang.IllegalThreadStateException,
                                          RemoteException,
                                          java.util.concurrent.TimeoutException,
                                          ShutdownInvocationException

GetAccessibleName

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getCaption

public java.lang.String getCaption(java.lang.String uID)
                            throws java.lang.IllegalThreadStateException,
                                   RemoteException,
                                   java.util.concurrent.TimeoutException,
                                   ShutdownInvocationException

GetCaption

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getCurrentWindow

public java.lang.String getCurrentWindow()
                                  throws java.lang.IllegalThreadStateException,
                                         RemoteException,
                                         java.util.concurrent.TimeoutException,
                                         ShutdownInvocationException

GetCurrentWindow

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getChildCount

public int getChildCount(java.lang.String uID)
                  throws java.lang.IllegalThreadStateException,
                         RemoteException,
                         java.util.concurrent.TimeoutException,
                         ShutdownInvocationException

GetChildCount

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getChildren

public java.lang.String[] getChildren(java.lang.String uID)
                               throws java.lang.IllegalThreadStateException,
                                      RemoteException,
                                      java.util.concurrent.TimeoutException,
                                      ShutdownInvocationException

GetChildren

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getClassIndex

public int getClassIndex(java.lang.String uID)
                  throws java.lang.IllegalThreadStateException,
                         RemoteException,
                         java.util.concurrent.TimeoutException,
                         ShutdownInvocationException

GetClassIndex

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getClassname

public java.lang.String getClassname(java.lang.String uID)
                              throws java.lang.IllegalThreadStateException,
                                     RemoteException,
                                     java.util.concurrent.TimeoutException,
                                     ShutdownInvocationException

GetClassname

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getId

public java.lang.String getId(java.lang.String uID)
                       throws java.lang.IllegalThreadStateException,
                              RemoteException,
                              java.util.concurrent.TimeoutException,
                              ShutdownInvocationException

GetId

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getMatchingChildObjects

public java.lang.String getMatchingChildObjects(java.lang.String parentUID,
                                                java.lang.String recognition)
                                         throws java.lang.IllegalThreadStateException,
                                                RemoteException,
                                                java.util.concurrent.TimeoutException,
                                                ShutdownInvocationException

GetMatchingChildObjects

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getMatchingParentObject

public java.lang.String getMatchingParentObject(java.lang.String recognition)
                                         throws java.lang.IllegalThreadStateException,
                                                RemoteException,
                                                java.util.concurrent.TimeoutException,
                                                ShutdownInvocationException

GetMatchingParentObject

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getName

public java.lang.String getName(java.lang.String uID)
                         throws java.lang.IllegalThreadStateException,
                                RemoteException,
                                java.util.concurrent.TimeoutException,
                                ShutdownInvocationException

GetName

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getNonAccessibleName

public java.lang.String getNonAccessibleName(java.lang.String uID)
                                      throws java.lang.IllegalThreadStateException,
                                             RemoteException,
                                             java.util.concurrent.TimeoutException,
                                             ShutdownInvocationException

GetNonAccessibleName

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getProperty

public java.lang.String getProperty(java.lang.String uID,
                                    java.lang.String propertyName)
                             throws java.lang.IllegalThreadStateException,
                                    RemoteException,
                                    java.util.concurrent.TimeoutException,
                                    ShutdownInvocationException

GetProperty

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getPropertyNames

public java.lang.String[] getPropertyNames(java.lang.String uID)
                                    throws java.lang.IllegalThreadStateException,
                                           RemoteException,
                                           java.util.concurrent.TimeoutException,
                                           ShutdownInvocationException

GetPropertyNames

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getSuperclassNames

public java.lang.String[] getSuperclassNames(java.lang.String uID)
                                      throws java.lang.IllegalThreadStateException,
                                             RemoteException,
                                             java.util.concurrent.TimeoutException,
                                             ShutdownInvocationException

GetSuperClassnames

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getText

public java.lang.String getText(java.lang.String uID)
                         throws java.lang.IllegalThreadStateException,
                                RemoteException,
                                java.util.concurrent.TimeoutException,
                                ShutdownInvocationException

GetText

Overrides:

getText in class Solo

Parameters:

uID - that is shown

Returns:

String UID for Text, or null if given text was not found. Field Solo._last_remote_result contains the returned Properties object.

The KEY_, PARAM_, STATUS_, cmd_, and target_ constants all come from the Message class and are used here and in the device/emulator Robotium Test Runner.

 (in ):KEY_TARGET= solo 
 (in ):KEY_COMMAND= cmd_getetexttext
 (out):KEY_ISREMOTERESULT=true
 (out):KEY_REMOTERESULTCODE=String:int:0=success/normal=STATUS_REMOTERESULT_OK
 (out):KEY_REMOTERESULTINFO=String containing the UID (unique ID) reference for the actual object 
 stored in remote cache. 
 (in ):PARAM_TEXT=String
 

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

See Also:

SoloRemoteControl.performRemotePropsCommand(Properties, int, int, int), Solo._last_remote_result, Message

getTopLevelCount

public int getTopLevelCount()
                     throws java.lang.IllegalThreadStateException,
                            RemoteException,
                            java.util.concurrent.TimeoutException,
                            ShutdownInvocationException

GetTopLevelCount

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

getTopLevelWindows

public java.lang.String[] getTopLevelWindows()
                                      throws java.lang.IllegalThreadStateException,
                                             RemoteException,
                                             java.util.concurrent.TimeoutException,
                                             ShutdownInvocationException

GetTopLevelWindows

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

highlightMatchingChildObjectByKey

public void highlightMatchingChildObjectByKey(java.lang.String parentUID,
                                              java.lang.String childUID)
                                       throws java.lang.IllegalThreadStateException,
                                              RemoteException,
                                              java.util.concurrent.TimeoutException,
                                              ShutdownInvocationException

HighlightMatchingChildObjectByKey

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

isEnabled

public boolean isEnabled(java.lang.String uID)
                  throws java.lang.IllegalThreadStateException,
                         RemoteException,
                         java.util.concurrent.TimeoutException,
                         ShutdownInvocationException

IsEnabled

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

isShowing

public boolean isShowing(java.lang.String uID)
                  throws java.lang.IllegalThreadStateException,
                         RemoteException,
                         java.util.concurrent.TimeoutException,
                         ShutdownInvocationException

IsShowing

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

isValid

public boolean isValid(java.lang.String uID)
                throws java.lang.IllegalThreadStateException,
                       RemoteException,
                       java.util.concurrent.TimeoutException,
                       ShutdownInvocationException

IsValid

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

isTopLevelPopupContainer

public boolean isTopLevelPopupContainer(java.lang.String uID)
                                 throws java.lang.IllegalThreadStateException,
                                        RemoteException,
                                        java.util.concurrent.TimeoutException,
                                        ShutdownInvocationException

IsTopLevelPopupContainer

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException

setActiveWindow

public void setActiveWindow(java.lang.String uID)
                     throws java.lang.IllegalThreadStateException,
                            RemoteException,
                            java.util.concurrent.TimeoutException,
                            ShutdownInvocationException

SetActiveWindow

Throws:

java.lang.IllegalThreadStateException

RemoteException - -- if a remote exception was thrown, or if the status indicates the command did not execute properly on the remote device or emulator.

java.util.concurrent.TimeoutException

ShutdownInvocationException