IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft.services
Class BasicActionRecorderEventService

java.lang.Object
  extended by com.rational.test.ft.services.BasicActionRecorderEventService
All Implemented Interfaces:
IActionRecorderEventService

public class BasicActionRecorderEventService
extends java.lang.Object
implements 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". In this implementation the "pending events domains" is simply a semicolon seperated list stored in SpyMemory.


Constructor Summary
BasicActionRecorderEventService()
           
 
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)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicActionRecorderEventService

public BasicActionRecorderEventService()
Method Detail

getPendingEventsDomains

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

Specified by:
getPendingEventsDomains in interface IActionRecorderEventService
Returns:
an array of the domains with pending events

setPendingEventsDomain

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

Specified by:
setPendingEventsDomain in interface IActionRecorderEventService
Parameters:
domainName -

clearPendingEventsDomain

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

Specified by:
clearPendingEventsDomain in interface IActionRecorderEventService
Parameters:
domainName -

isRecorderRunning

public boolean isRecorderRunning()
Specified by:
isRecorderRunning in interface IActionRecorderEventService
Returns:
TRUE if the recorder is running

setPrepareToStopDomain

public 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.

Specified by:
setPrepareToStopDomain in interface IActionRecorderEventService
Parameters:
domainName -

getPrepareToStopDomains

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

Specified by:
getPrepareToStopDomains in interface IActionRecorderEventService
Returns:
an array of the domains having this ready to stop mechanism

clearPrepareToStopDomain

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

Specified by:
clearPrepareToStopDomain in interface IActionRecorderEventService
Parameters:
domainName -

setReadyToStopDomain

public void setReadyToStopDomain(java.lang.String domainName)
Specified by:
setReadyToStopDomain in interface IActionRecorderEventService

getReadyToStopDomains

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

Specified by:
getReadyToStopDomains in interface IActionRecorderEventService
Returns:
an array of the domains having this ready to stop mechanism

clearReadyToStopDomain

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

Specified by:
clearReadyToStopDomain in interface IActionRecorderEventService
Parameters:
domainName -