org.safs.android
Class SocketTestRecordHelper

java.lang.Object
  extended by org.safs.TestRecordData
      extended by org.safs.TestRecordHelper
          extended by org.safs.android.SocketTestRecordHelper
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
DTestRecordHelper

public class SocketTestRecordHelper
extends TestRecordHelper

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.safs.TestRecordHelper
requester
 
Fields inherited from class org.safs.TestRecordData
possibleSeparator
 
Constructor Summary
SocketTestRecordHelper()
           
 
Method Summary
 void addKeywordProperty(java.lang.String propname, java.lang.String propvalue)
          Add a keyword property to the Properties list.
 java.util.Properties getKeywordProperties()
          Can be null if no additional properties/values are needed for remote execution.
 java.lang.String getKeywordProperty(java.lang.String propname)
          Get a keyword property from the Properties list.
 boolean processRemotely()
           
 void reinit()
          Set our added fields to their default values during each command initialization:
setKeywordProperties(false);
setProcessRemotely(true);
 void setKeywordProperties(java.util.Properties _props)
          Can set to null if no additional properties/values are needed for remote execution.
 void setProcessRemotely(boolean processRemotely)
          Keyword implementors will set this to true if the keyword is expecting a remote engine to complete the processing of the inputrecord.
 
Methods inherited from class org.safs.TestRecordHelper
getCompGuiId, getCompInstancePath, getConfig, getDDGUtils, getStaf, getSTAFHelper, getWindowGuiId, isMixedRsUsed, populateDataFromVar, sendbackResponse, setConfig, setDDGUtils, setSTAFHelper
 
Methods inherited from class org.safs.TestRecordData
copyData, getAltCompType, getAppMapName, getCommand, getCompClass, getCompModule, getCompName, getCompType, getEnvironment, getFac, getFileID, getFilename, getInputRecord, getInputRecordToken, getInstanceName, getLineNumber, getNotSeparatorString, getRecordType, getSeparator, getStatusCode, getStatusInfo, getTestLevel, getTrimmedUnquotedInputRecordToken, getWindowName, inputRecordSize, setAltCompType, setAppMapName, setCommand, setCompClass, setCompGuiId, setCompModule, setCompName, setCompType, setEnvironment, setFac, setFileID, setFilename, setInputRecord, setInstanceName, setLineNumber, setRecordType, setSeparator, setShutdownData, setStatusCode, setStatusInfo, setTestLevel, setWindowGuiId, setWindowName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SocketTestRecordHelper

public SocketTestRecordHelper()
Method Detail

getKeywordProperties

public java.util.Properties getKeywordProperties()
Can be null if no additional properties/values are needed for remote execution.


setKeywordProperties

public void setKeywordProperties(java.util.Properties _props)
Can set to null if no additional properties/values are needed for remote execution.


addKeywordProperty

public void addKeywordProperty(java.lang.String propname,
                               java.lang.String propvalue)
Add a keyword property to the Properties list. If the Properties list does not yet exist, it will be created prior to adding the new keyword property.

Parameters:
propname - case-insensitive name of the property. It will be stored and transmitted in lowerCase.
propvalue - case-sensitive value for the property.

getKeywordProperty

public java.lang.String getKeywordProperty(java.lang.String propname)
Get a keyword property from the Properties list.

Parameters:
propname - case-insensitive name of the property. It will be converted to lowerCase before use.
Returns:
String value of the property, or null.

processRemotely

public boolean processRemotely()
Returns:
true if the underlying engine is expected to dispatch the command to a remote engine. return false if the keyword was handled locally in its entirety.

setProcessRemotely

public void setProcessRemotely(boolean processRemotely)
Keyword implementors will set this to true if the keyword is expecting a remote engine to complete the processing of the inputrecord.

Parameters:
processRemotely - set true if the underlying engine is expected to dispatch the command to a remote engine. set false if the keyword was handled locally in its entirety.

reinit

public void reinit()
Set our added fields to their default values during each command initialization:
setKeywordProperties(false);
setProcessRemotely(true);

Overrides:
reinit in class TestRecordData
See Also:
TestRecordData.reinit()