org.safs.tools

Interface GenericToolsInterface

All Known Subinterfaces:

ConfigurableToolsInterface, EngineInterface, SimpleToolsInterface

All Known Implementing Classes:

AutoItComponent, DriverConfiguredSTAFInterfaceClass, GenericEngine, SAFSABBOT, SAFSCOUNTERS, SAFSDRIVERCOMMANDS, SAFSDROID, SAFSINPUT, SAFSIOS, SAFSLOGS, SAFSMAPS, SAFSQTP, SAFSROBOTJ, SAFSSELENIUM, SAFSSTACKS, SAFSSTATUS, SAFSTC, SAFSVARS, STAFLocalServer, TIDComponent, TIDDriverCommands, TIDDriverCounterCommands, TIDDriverFlowCommands, TIDDriverLogCommands, TIDDriverRestCommands

public interface GenericToolsInterface

Method Summary

Modifier and Type	Method and Description
CoreInterface	getCoreInterface() Retrieve the instance of the CoreInterface used to communicate with the framework.
boolean	isToolRunning() TRUE if the underlying tool is running.
void	reset() Reset or clear any cached information in the underlying tool or service.
void	shutdown() Shutdown the underlying tool or service.

Method Detail

reset

void reset()

Reset or clear any cached information in the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is not actually running. If the tool is not running, then this should exit gracefully without adversely affecting anything.

shutdown

void shutdown()

Shutdown the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is not actually running. If the tool is not running, then this should exit gracefully without adversely affecting anything.

isToolRunning

boolean isToolRunning()

TRUE if the underlying tool is running. Typically called AFTER initialization attempts have been made.

getCoreInterface

CoreInterface getCoreInterface()
                        throws java.lang.IllegalStateException

Retrieve the instance of the CoreInterface used to communicate with the framework.

Returns:

CoreInterface instance.

Throws:

java.lang.IllegalStateException - if the CoreInterface is null, has not been initialized yet, or is otherwise invalid.