IBM Rational Functional Tester
Version 8.2.1
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft.services
Interface IActionRecorderEventService

All Known Implementing Classes:
BasicActionRecorderEventService

public interface IActionRecorderEventService

This is the service to abstract the signaling of recorder events between the SUT and the recorder. For domains where the SUT receives events from an assistive technology (e.g. CAS when testing Siebel), the domain can signal that the ActionRecorder should ping it for the event. Any domain that supports this model should implement getProxyEvents, which the recorder calls when the proxy "setPendingEventsDomain".


Method Summary
 void clearPendingEventsDomain(java.lang.String domainName)
          signal that domainName does not have any pending events that the recorer needs to pick up
 void clearPrepareToStopDomain(java.lang.String domainName)
          signal that domainName has finished with flush and notification and it needs to clear.
 void clearReadyToStopDomain(java.lang.String domainName)
          signal that domainName has finished with flush and notification and it needs to clear.
 java.lang.String[] getPendingEventsDomains()
          get a list of the domains that have events to be delivered to the recorder.
 java.lang.String[] getPrepareToStopDomains()
          get a list of the domains that has above flushing mechanism and notification to the recorder.
 java.lang.String[] getReadyToStopDomains()
          get a list of the domains that has above flushing mechanism and notification to the recorder.
 boolean isRecorderRunning()
           
 void setPendingEventsDomain(java.lang.String domainName)
          indicate that the specified domain has pending events that need to be delivered to the recorder.
 void setPrepareToStopDomain(java.lang.String domainName)
          Domains like SAP will be having events in the automation layer's event queue that is still not delivered to RFT.
 void setReadyToStopDomain(java.lang.String domainName)
           
 

Method Detail

setPendingEventsDomain

void setPendingEventsDomain(java.lang.String domainName)
indicate that the specified domain has pending events that need to be delivered to the recorder.

Parameters:
domainName -

getPendingEventsDomains

java.lang.String[] getPendingEventsDomains()
get a list of the domains that have events to be delivered to the recorder.

Returns:
an array of the domains with pending events

clearPendingEventsDomain

void clearPendingEventsDomain(java.lang.String domainName)
signal that domainName does not have any pending events that the recorer needs to pick up

Parameters:
domainName -

isRecorderRunning

boolean isRecorderRunning()
Returns:
TRUE if the recorder is running

setPrepareToStopDomain

void setPrepareToStopDomain(java.lang.String domainName)
Domains like SAP will be having events in the automation layer's event queue that is still not delivered to RFT. During record stop we need to flush those events from the automation layer. This method indicate that the specified domain has mechanism to flush events and notify therecorder that it's finished with flusing and ready to stop.The records uses it to graciously stop the recording session.

Parameters:
domainName -

getPrepareToStopDomains

java.lang.String[] getPrepareToStopDomains()
get a list of the domains that has above flushing mechanism and notification to the recorder.

Returns:
an array of the domains having this ready to stop mechanism

clearPrepareToStopDomain

void clearPrepareToStopDomain(java.lang.String domainName)
signal that domainName has finished with flush and notification and it needs to clear.

Parameters:
domainName -

setReadyToStopDomain

void setReadyToStopDomain(java.lang.String domainName)

getReadyToStopDomains

java.lang.String[] getReadyToStopDomains()
get a list of the domains that has above flushing mechanism and notification to the recorder.

Returns:
an array of the domains having this ready to stop mechanism

clearReadyToStopDomain

void clearReadyToStopDomain(java.lang.String domainName)
signal that domainName has finished with flush and notification and it needs to clear.

Parameters:
domainName -