com.attachmate.sc.ssa
Interface IPerformanceTool

All Known Implementing Classes:

BaseCustomNavStep, BaseCustomNavStepEx

public interface IPerformanceTool

Custom Steps Only
This interface defines helper methods to assist the IController objects in increasing performance. The constants defined below are returned by the datastream processor, giving the status of the read. They may be used to determine the "settled" state of the screens.

Field Summary

static int	STATUS_DATA_CHANGED Screen data changed
static int	STATUS_EOR End of record.
static int	STATUS_FORMAT_CHANGED Screen format changed
static int	STATUS_KBD_UNLOCK Lock status changed
static int	STATUS_MESSAGE_WAITING Message waiting status
static int	STATUS_SCREEN_ERASED Screen erased.
static int	STATUS_SIZE_CHANGED Screen size changed
static int	STATUS_TYPE_CHANGED Data type changed

Method Summary

boolean

onReadExit(int readStatus, boolean bTimedOut) Called by the controller while performing sendKeys to determine if the screen has settled.

Field Detail

STATUS_MESSAGE_WAITING

public static final int STATUS_MESSAGE_WAITING

Message waiting status

See Also:

Constant Field Values

STATUS_TYPE_CHANGED

public static final int STATUS_TYPE_CHANGED

Data type changed

See Also:

Constant Field Values

STATUS_SIZE_CHANGED

public static final int STATUS_SIZE_CHANGED

Screen size changed

See Also:

Constant Field Values

STATUS_FORMAT_CHANGED

public static final int STATUS_FORMAT_CHANGED

Screen format changed

See Also:

Constant Field Values

STATUS_DATA_CHANGED

public static final int STATUS_DATA_CHANGED

Screen data changed

See Also:

Constant Field Values

STATUS_KBD_UNLOCK

public static final int STATUS_KBD_UNLOCK

Lock status changed

See Also:

Constant Field Values

STATUS_SCREEN_ERASED

public static final int STATUS_SCREEN_ERASED

Screen erased. Not guaranteed a data changed as well.

See Also:

Constant Field Values

STATUS_EOR

public static final int STATUS_EOR

End of record.

See Also:

Constant Field Values

Method Detail

onReadExit

public boolean onReadExit(int readStatus,
                          boolean bTimedOut)
                   throws com.attachmate.nav.engine.NavException

Called by the controller while performing sendKeys to determine if the screen has settled. The developer may override this method to enhance performance and reliablity over the default settle trime mechanism.

Parameters:

readStatus - the read return code.

bTimedOut - if true the previous read timed out

Returns:

true if read should exit, false if we should perform another read.

com.attachmate.nav.engine.NavException

See Also:

DefaultController.read()