org.safs.tools.engines

Interface EngineInterface

All Superinterfaces:

ConfigurableToolsInterface, GenericToolsInterface, Versionable

All Known Implementing Classes:

AutoItComponent, GenericEngine, SAFSABBOT, SAFSDRIVERCOMMANDS, SAFSDROID, SAFSIOS, SAFSQTP, SAFSROBOTJ, SAFSSELENIUM, SAFSTC, TIDComponent, TIDDriverCommands, TIDDriverCounterCommands, TIDDriverFlowCommands, TIDDriverLogCommands, TIDDriverRestCommands

public interface EngineInterface
extends ConfigurableToolsInterface, Versionable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMAND_SHUTDOWN_HOOK "SHUTDOWN_HOOK" A TRD inputrecord command to terminate and shutdown the hook normally.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEngineName() Retrieve the name of the Engine.
long	processRecord(TestRecordHelper testRecordData) Execute the processing of a stored test record.

Methods inherited from interface org.safs.tools.ConfigurableToolsInterface

launchInterface

Methods inherited from interface org.safs.tools.GenericToolsInterface

getCoreInterface, isToolRunning, reset, shutdown

Methods inherited from interface org.safs.tools.Versionable

getDescription, getProductName, getVersion, setDescription, setProductName, setVersion

Field Detail

COMMAND_SHUTDOWN_HOOK

static final java.lang.String COMMAND_SHUTDOWN_HOOK

"SHUTDOWN_HOOK" A TRD inputrecord command to terminate and shutdown the hook normally.

See Also:

Constant Field Values

Method Detail

getEngineName

java.lang.String getEngineName()

Retrieve the name of the Engine. For example, SAFS/DriverCommands. For STAF engines, this would be the engine's process name in STAF.

processRecord

long processRecord(TestRecordHelper testRecordData)

Execute the processing of a stored test record. The test record and associated test record data should already be stored and accessible to the engine. The routine should return a standard return code as defined in our DriverConstants.

For STAF engines, this means the Test Record Data is stored in the predefined SAFSVARS storage.

For other engines, this will be implementation specific.

Returns:

the status code resulting from the processing.

• 4 -- SCRIPT NOT EXECUTED. "I did not process this record."
• -1 -- NO SCRIPT FAILURE. "I processed the record successfully."
• -2 -- SCRIPT WARNING. "I processed the record, issued warning(s)."
• 0 -- SCRIPT FAILURE. "I processed the record, issued failure(s)."
• 2 -- IO FAILURE. "I process the record, issued IO failure(s)."
• 8 -- EXIT TABLE. "I processed the record, exit current table."
• 16 -- IGNORE STATUS. "I processed the record, ignore code and continue."

See Also:

DriverConstants