DDDriverCounterCommands (SAFS API DOCUMENT)

java.lang.Object
- org.safs.model.commands.DDDriverCounterCommands

public class DDDriverCounterCommands
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DELETECOUNTER_KEYWORD` "DeleteCounter"
`static java.lang.String`	`LOGCOUNTERINFO_KEYWORD` "LogCounterInfo"
`static java.lang.String`	`RESETCOUNTER_KEYWORD` "ResetCounter"
`static java.lang.String`	`RESUMESTATUSCOUNTS_KEYWORD` "ResumeStatusCounts"
`static java.lang.String`	`SETCOUNTERMODE_KEYWORD` "SetCounterMode"
`static java.lang.String`	`STARTCOUNTER_KEYWORD` "StartCounter"
`static java.lang.String`	`STARTCYCLE_KEYWORD` "StartCycle"
`static java.lang.String`	`STARTPROCEDURE_KEYWORD` "StartProcedure"
`static java.lang.String`	`STARTREQUIREMENT_KEYWORD` "StartRequirement"
`static java.lang.String`	`STARTSUITE_KEYWORD` "StartSuite"
`static java.lang.String`	`STARTTESTCASE_KEYWORD` "StartTestcase"
`static java.lang.String`	`STOPCOUNTER_KEYWORD` "StopCounter"
`static java.lang.String`	`STOPCYCLE_KEYWORD` "StopCycle"
`static java.lang.String`	`STOPPROCEDURE_KEYWORD` "StopProcedure"
`static java.lang.String`	`STOPREQUIREMENT_KEYWORD` "StopRequirement"
`static java.lang.String`	`STOPSUITE_KEYWORD` "StopSuite"
`static java.lang.String`	`STOPTESTCASE_KEYWORD` "StopTestcase"
`static java.lang.String`	`STORECOUNTERINFO_KEYWORD` "StoreCounterInfo"
`static java.lang.String`	`SUSPENDSTATUSCOUNTS_KEYWORD` "SuspendStatusCounts"

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static DriverCommand`	`deleteCounter(java.lang.String[] parameters)` Delete any existing private counter with the provided counterID.
`static DriverCommand`	`deleteCounter(java.lang.String counterID, java.lang.String description)` Delete any existing private counter with the provided counterID.
`static DDDriverCounterCommands`	`getInstance()` public Singleton to access class static methods via instance
`static DriverCommand`	`logCounterInfo(java.lang.String[] parameters)` Log the specified counter's info in the active log(s) of the current Log Facility.
`static DriverCommand`	`logCounterInfo(java.lang.String counterID, java.lang.String logName)` Log the specified counter's info in the active log(s) of the current Log Facility.
`static DriverCommand`	`resetCounter(java.lang.String[] parameters)` Create a new private counter or reset counts in an existing private counter.
`static DriverCommand`	`resetCounter(java.lang.String counterID, java.lang.String description)` Create a new private counter or reset counts in an existing private counter.
`static DriverCommand`	`resumeStatusCounts(java.lang.String[] parameters)` Resume counting on ALL status counters--both public/global and private.
`static DriverCommand`	`resumeStatusCounts(java.lang.String description, java.lang.String logName)` Resume counting on ALL status counters--both public/global and private.
`static DriverCommand`	`setCounterMode(java.lang.String[] parameters)` Create a new private counter or modify the mode of an existing private counter.
`static DriverCommand`	`setCounterMode(java.lang.String counterID, java.lang.String mode)` Create a new private counter or modify the mode of an existing private counter.
`static DriverCommand`	`startCounter(java.lang.String[] parameters)` Create a new private counter or start an existing stopped private counter.
`static DriverCommand`	`startCounter(java.lang.String counterID, java.lang.String description)` Create a new private counter or start an existing stopped private counter.
`static DriverCommand`	`startCycle(java.lang.String[] parameters)` Begin tracking status on a user-defined item.
`static DriverCommand`	`startCycle(java.lang.String cycleID, java.lang.String description)` Begin tracking status on a user-defined item.
`static DriverCommand`	`startProcedure(java.lang.String[] parameters)` Begin tracking status on a user-defined item.
`static DriverCommand`	`startProcedure(java.lang.String procedureID, java.lang.String description)` Begin tracking status on a user-defined item.
`static DriverCommand`	`startRequirement(java.lang.String[] parameters)` Begin tracking status on a user-defined item.
`static DriverCommand`	`startRequirement(java.lang.String requirementID, java.lang.String description)` Begin tracking status on a user-defined item.
`static DriverCommand`	`startSuite(java.lang.String[] parameters)` Begin tracking status on a user-defined item.
`static DriverCommand`	`startSuite(java.lang.String suiteID, java.lang.String description)` Begin tracking status on a user-defined item.
`static DriverCommand`	`startTestcase(java.lang.String[] parameters)` Begin tracking status on a user-defined TestCase.
`static DriverCommand`	`startTestcase(java.lang.String testCaseID, java.lang.String description)` Begin tracking status on a user-defined TestCase.
`static DriverCommand`	`stopCounter(java.lang.String[] parameters)` Create a new private counter or suspend counts in an existing private counter.
`static DriverCommand`	`stopCounter(java.lang.String counterID, java.lang.String description)` Create a new private counter or suspend counts in an existing private counter.
`static DriverCommand`	`stopCycle(java.lang.String[] parameters)` Stop tracking status on a user-defined item.
`static DriverCommand`	`stopCycle(java.lang.String cycleID, java.lang.String description)` Stop tracking status on a user-defined item.
`static DriverCommand`	`stopProcedure(java.lang.String[] parameters)` Stop tracking status on a user-defined item.
`static DriverCommand`	`stopProcedure(java.lang.String procedureID, java.lang.String description)` Stop tracking status on a user-defined item.
`static DriverCommand`	`stopRequirement(java.lang.String[] parameters)` Stop tracking status on a user-defined item.
`static DriverCommand`	`stopRequirement(java.lang.String requirementID, java.lang.String description)` Stop tracking status on a user-defined item.
`static DriverCommand`	`stopSuite(java.lang.String[] parameters)` Stop tracking status on a user-defined item.
`static DriverCommand`	`stopSuite(java.lang.String suiteID, java.lang.String description)` Stop tracking status on a user-defined item.
`static DriverCommand`	`stopTestcase(java.lang.String[] parameters)` Stop tracking status on a user-defined TestCase.
`static DriverCommand`	`stopTestcase(java.lang.String testCaseID, java.lang.String description)` Stop tracking status on a user-defined TestCase.
`static DriverCommand`	`storeCounterInfo(java.lang.String[] parameters)` Store the current values of the named counter into unique DDVariables.
`static DriverCommand`	`storeCounterInfo(java.lang.String counterID, java.lang.String varPrefix)` Store the current values of the named counter into unique DDVariables.
`static DriverCommand`	`suspendStatusCounts(java.lang.String[] parameters)` Suspend counting on ALL status counters--both public/global and private.
`static DriverCommand`	`suspendStatusCounts(java.lang.String description, java.lang.String logName)` Suspend counting on ALL status counters--both public/global and private.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- DELETECOUNTER_KEYWORD
```
public static final java.lang.String DELETECOUNTER_KEYWORD
```
  "DeleteCounter"
  
  See Also:
  
  Constant Field Values
- LOGCOUNTERINFO_KEYWORD
```
public static final java.lang.String LOGCOUNTERINFO_KEYWORD
```
  "LogCounterInfo"
  
  See Also:
  
  Constant Field Values
- RESETCOUNTER_KEYWORD
```
public static final java.lang.String RESETCOUNTER_KEYWORD
```
  "ResetCounter"
  
  See Also:
  
  Constant Field Values
- RESUMESTATUSCOUNTS_KEYWORD
```
public static final java.lang.String RESUMESTATUSCOUNTS_KEYWORD
```
  "ResumeStatusCounts"
  
  See Also:
  
  Constant Field Values
- SETCOUNTERMODE_KEYWORD
```
public static final java.lang.String SETCOUNTERMODE_KEYWORD
```
  "SetCounterMode"
  
  See Also:
  
  Constant Field Values
- STARTCOUNTER_KEYWORD
```
public static final java.lang.String STARTCOUNTER_KEYWORD
```
  "StartCounter"
  
  See Also:
  
  Constant Field Values
- STARTCYCLE_KEYWORD
```
public static final java.lang.String STARTCYCLE_KEYWORD
```
  "StartCycle"
  
  See Also:
  
  Constant Field Values
- STARTPROCEDURE_KEYWORD
```
public static final java.lang.String STARTPROCEDURE_KEYWORD
```
  "StartProcedure"
  
  See Also:
  
  Constant Field Values
- STARTREQUIREMENT_KEYWORD
```
public static final java.lang.String STARTREQUIREMENT_KEYWORD
```
  "StartRequirement"
  
  See Also:
  
  Constant Field Values
- STARTSUITE_KEYWORD
```
public static final java.lang.String STARTSUITE_KEYWORD
```
  "StartSuite"
  
  See Also:
  
  Constant Field Values
- STARTTESTCASE_KEYWORD
```
public static final java.lang.String STARTTESTCASE_KEYWORD
```
  "StartTestcase"
  
  See Also:
  
  Constant Field Values
- STOPCOUNTER_KEYWORD
```
public static final java.lang.String STOPCOUNTER_KEYWORD
```
  "StopCounter"
  
  See Also:
  
  Constant Field Values
- STOPCYCLE_KEYWORD
```
public static final java.lang.String STOPCYCLE_KEYWORD
```
  "StopCycle"
  
  See Also:
  
  Constant Field Values
- STOPPROCEDURE_KEYWORD
```
public static final java.lang.String STOPPROCEDURE_KEYWORD
```
  "StopProcedure"
  
  See Also:
  
  Constant Field Values
- STOPREQUIREMENT_KEYWORD
```
public static final java.lang.String STOPREQUIREMENT_KEYWORD
```
  "StopRequirement"
  
  See Also:
  
  Constant Field Values
- STOPSUITE_KEYWORD
```
public static final java.lang.String STOPSUITE_KEYWORD
```
  "StopSuite"
  
  See Also:
  
  Constant Field Values
- STOPTESTCASE_KEYWORD
```
public static final java.lang.String STOPTESTCASE_KEYWORD
```
  "StopTestcase"
  
  See Also:
  
  Constant Field Values
- STORECOUNTERINFO_KEYWORD
```
public static final java.lang.String STORECOUNTERINFO_KEYWORD
```
  "StoreCounterInfo"
  
  See Also:
  
  Constant Field Values
- SUSPENDSTATUSCOUNTS_KEYWORD
```
public static final java.lang.String SUSPENDSTATUSCOUNTS_KEYWORD
```
  "SuspendStatusCounts"
  
  See Also:
  
  Constant Field Values

Method Detail

getInstance
```
public static DDDriverCounterCommands getInstance()
```
public Singleton to access class static methods via instance

deleteCounter

public static DriverCommand deleteCounter(java.lang.String counterID,
                                          java.lang.String description)

 
                 Delete any existing private counter with the provided counterID.
              
                 If counterID identifies an existing counter, then delete it.
                 See ApplicationUtilities for more information on private counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:: counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.; description - Optional:YES Any additional information for deleting this counter.

deleteCounter
```
public static DriverCommand deleteCounter(java.lang.String[] parameters)
```
```
 
                 Delete any existing private counter with the provided counterID.
              
                 If counterID identifies an existing counter, then delete it.
                 See ApplicationUtilities for more information on private counters.
                  
```
Supporting Engines:
- Rational Robot
- SAFS TIDDriverCommands
- Mercury Interactive WinRunner
Parameters:
parameters - Optional:NO An array containing the following parameters:

logCounterInfo

public static DriverCommand logCounterInfo(java.lang.String counterID,
                                           java.lang.String logName)

 
                 Log the specified counter's info in the active log(s) of the current Log Facility.
              
                 Extracts a snapshot of the specified private counter and outputs a 
                 small, embedded Status Report in the active logs of the current Log Facility.
                 The Status Report will be identified by the name of the private counter.
                 (Future) We will allow you to optionally specify a different Log Facility by name.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:: counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.; logName - Optional:YES DefaultVal:MainLog (Future) The name of a Log Facility other than the "current" one.

logCounterInfo

public static DriverCommand logCounterInfo(java.lang.String[] parameters)

 
                 Log the specified counter's info in the active log(s) of the current Log Facility.
              
                 Extracts a snapshot of the specified private counter and outputs a 
                 small, embedded Status Report in the active logs of the current Log Facility.
                 The Status Report will be identified by the name of the private counter.
                 (Future) We will allow you to optionally specify a different Log Facility by name.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

resetCounter

public static DriverCommand resetCounter(java.lang.String counterID,
                                         java.lang.String description)

 
                 Create a new private counter or reset counts in an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels.
                 If counterID identifies an existing counter, then this routine 
                 will reset all its counts to zero(0).
                 See ApplicationUtilities for more information on private counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:: counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.; description - Optional:YES Any additional information for resetting this counter.

resetCounter

public static DriverCommand resetCounter(java.lang.String[] parameters)

 
                 Create a new private counter or reset counts in an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels.
                 If counterID identifies an existing counter, then this routine 
                 will reset all its counts to zero(0).
                 See ApplicationUtilities for more information on private counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:

parameters - Optional:NO An array containing the following parameters:

resumeStatusCounts

public static DriverCommand resumeStatusCounts(java.lang.String description,
                                               java.lang.String logName)

 
                 Resume counting on ALL status counters--both public/global and private.
              
                 Resume all status counting that is triggered via ApplicationUtilities.
                 Only counters that are enabled--not independently "stopped"--will resume
                 counting.  Stopped counters are still stopped.
                 See ApplicationUtilities for more information on counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:: description - Optional:YES Any additional information for resuming status counts.; logName - Optional:YES DefaultVal:MainLog (Future) The name of a Log Facility other than the "current" one.

resumeStatusCounts

public static DriverCommand resumeStatusCounts(java.lang.String[] parameters)

 
                 Resume counting on ALL status counters--both public/global and private.
              
                 Resume all status counting that is triggered via ApplicationUtilities.
                 Only counters that are enabled--not independently "stopped"--will resume
                 counting.  Stopped counters are still stopped.
                 See ApplicationUtilities for more information on counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

setCounterMode

public static DriverCommand setCounterMode(java.lang.String counterID,
                                           java.lang.String mode)

 
                 Create a new private counter or modify the mode of an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID and counting mode.
                 If counterID identifies an existing counter, then this routine 
                 will modify the counting mode of the existing counter.
                 See AUSetStatusCounterMode for more information on private counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:: counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.; mode - Optional:NO DefaultVal:AllStatusInfo The counting mode to use for the specified counter.

setCounterMode

public static DriverCommand setCounterMode(java.lang.String[] parameters)

 
                 Create a new private counter or modify the mode of an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID and counting mode.
                 If counterID identifies an existing counter, then this routine 
                 will modify the counting mode of the existing counter.
                 See AUSetStatusCounterMode for more information on private counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:

parameters - Optional:NO An array containing the following parameters:

startCounter

public static DriverCommand startCounter(java.lang.String counterID,
                                         java.lang.String description)

 
                 Create a new private counter or start an existing stopped private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels.
                 If counterID identifies an existing counter, then this routine 
                 will enable the counter to resume counting--assuming it was stopped.
                 See ApplicationUtilities for more information on private counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:: counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.; description - Optional:YES Any additional information such as the purpose of the counter.

startCounter

public static DriverCommand startCounter(java.lang.String[] parameters)

 
                 Create a new private counter or start an existing stopped private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels.
                 If counterID identifies an existing counter, then this routine 
                 will enable the counter to resume counting--assuming it was stopped.
                 See ApplicationUtilities for more information on private counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

startCycle

public static DriverCommand startCycle(java.lang.String cycleID,
                                       java.lang.String description)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:: cycleID - Optional:NO The user-defined ID of the item.; description - Optional:YES A description of the item.

startCycle

public static DriverCommand startCycle(java.lang.String[] parameters)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:

parameters - Optional:NO An array containing the following parameters:

startProcedure

public static DriverCommand startProcedure(java.lang.String procedureID,
                                           java.lang.String description)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:: procedureID - Optional:NO The user-defined ID of the item.; description - Optional:YES A description of the item.

startProcedure

public static DriverCommand startProcedure(java.lang.String[] parameters)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:

parameters - Optional:NO An array containing the following parameters:

startRequirement

public static DriverCommand startRequirement(java.lang.String requirementID,
                                             java.lang.String description)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:: requirementID - Optional:NO The user-defined ID of the item.; description - Optional:YES A description of the item.

startRequirement

public static DriverCommand startRequirement(java.lang.String[] parameters)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:

parameters - Optional:NO An array containing the following parameters:

startSuite

public static DriverCommand startSuite(java.lang.String suiteID,
                                       java.lang.String description)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:: suiteID - Optional:NO The user-defined ID of the item.; description - Optional:YES A description of the item.

startSuite
```
public static DriverCommand startSuite(java.lang.String[] parameters)
```
```
          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.
            
```
Supporting Engines:
- Rational Robot
- SAFS TIDDriverCommands
- Mercury Interactive WinRunner
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

startTestcase

public static DriverCommand startTestcase(java.lang.String testCaseID,
                                          java.lang.String description)

          Begin tracking status on a user-defined TestCase.
          Log/process the beginning of testing associated with a user-defined Testcase.
          A private counter 
          will keep track of status for the testcase.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:: testCaseID - Optional:NO The user-defined ID of the Testcase.; description - Optional:YES A description of the Testcase

startTestcase
```
public static DriverCommand startTestcase(java.lang.String[] parameters)
```
```
          Begin tracking status on a user-defined TestCase.
          Log/process the beginning of testing associated with a user-defined Testcase.
          A private counter 
          will keep track of status for the testcase.
            
```
Supporting Engines:
- Rational Robot
- SAFS TIDDriverCommands
- Mercury Interactive WinRunner
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

stopCounter

public static DriverCommand stopCounter(java.lang.String counterID,
                                        java.lang.String description)

 
                 Create a new private counter or suspend counts in an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels but will be suspended 
                 from actually counting.
                 If counterID identifies an existing counter, then this routine 
                 will suspend counting within this counter.
                 See ApplicationUtilities for more information on private counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:: counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.; description - Optional:YES Any additional information for stopping this counter.

stopCounter

public static DriverCommand stopCounter(java.lang.String[] parameters)

 
                 Create a new private counter or suspend counts in an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels but will be suspended 
                 from actually counting.
                 If counterID identifies an existing counter, then this routine 
                 will suspend counting within this counter.
                 See ApplicationUtilities for more information on private counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

stopCycle

public static DriverCommand stopCycle(java.lang.String cycleID,
                                      java.lang.String description)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:: cycleID - Optional:NO The user-defined ID of the item.; description - Optional:YES A description of the item.

stopCycle

public static DriverCommand stopCycle(java.lang.String[] parameters)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:

parameters - Optional:NO An array containing the following parameters:

stopProcedure

public static DriverCommand stopProcedure(java.lang.String procedureID,
                                          java.lang.String description)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:: procedureID - Optional:NO The user-defined ID of the item.; description - Optional:YES A description of the item.

stopProcedure
```
public static DriverCommand stopProcedure(java.lang.String[] parameters)
```
```
          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.
            
```
Supporting Engines:
- Rational Robot
- SAFS TIDDriverCommands
- Mercury Interactive WinRunner
Parameters:
parameters - Optional:NO An array containing the following parameters:

stopRequirement

public static DriverCommand stopRequirement(java.lang.String requirementID,
                                            java.lang.String description)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:: requirementID - Optional:NO The user-defined ID of the item.; description - Optional:YES A description of the item.

stopRequirement
```
public static DriverCommand stopRequirement(java.lang.String[] parameters)
```
```
          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.
            
```
Supporting Engines:
- Rational Robot
- SAFS TIDDriverCommands
- Mercury Interactive WinRunner
Parameters:
parameters - Optional:NO An array containing the following parameters:

stopSuite

public static DriverCommand stopSuite(java.lang.String suiteID,
                                      java.lang.String description)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:: suiteID - Optional:NO The user-defined ID of the item.; description - Optional:YES A description of the item.

stopSuite

public static DriverCommand stopSuite(java.lang.String[] parameters)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner

Parameters:

parameters - Optional:NO An array containing the following parameters:

stopTestcase

public static DriverCommand stopTestcase(java.lang.String testCaseID,
                                         java.lang.String description)

          Stop tracking status on a user-defined TestCase.
          Log/process the end of testing associated with a user-defined Testcase.
          A private counter 
          will keep track of status for the testcase.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:: testCaseID - Optional:NO The user-defined ID of the Testcase.; description - Optional:YES A description of the Testcase

stopTestcase
```
public static DriverCommand stopTestcase(java.lang.String[] parameters)
```
```
          Stop tracking status on a user-defined TestCase.
          Log/process the end of testing associated with a user-defined Testcase.
          A private counter 
          will keep track of status for the testcase.
            
```
Supporting Engines:
- Rational Robot
- SAFS TIDDriverCommands
- Mercury Interactive WinRunner
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

storeCounterInfo

public static DriverCommand storeCounterInfo(java.lang.String counterID,
                                             java.lang.String varPrefix)

 
                 Store the current values of the named counter into unique DDVariables.
              
                 This enables the framework, scripts, and other applications to retrieve 
                 the values of these counters at runtime.
                 Consult ApplicationUtilities 
                 and Using DDVariables 
                 for more information on referencing these DDVariables in your tests.
                 You must adhere to DDVariable naming conventions when providing this 
                 DDVariable basename.  Note that no spaces are allowed in DDVariable names.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:: counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify the private counter.; varPrefix - Optional:NO DefaultVal:Counter1 The unique DDVariable prefix to use for storing counter values.

storeCounterInfo

public static DriverCommand storeCounterInfo(java.lang.String[] parameters)

 
                 Store the current values of the named counter into unique DDVariables.
              
                 This enables the framework, scripts, and other applications to retrieve 
                 the values of these counters at runtime.
                 Consult ApplicationUtilities 
                 and Using DDVariables 
                 for more information on referencing these DDVariables in your tests.
                 You must adhere to DDVariable naming conventions when providing this 
                 DDVariable basename.  Note that no spaces are allowed in DDVariable names.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

suspendStatusCounts

public static DriverCommand suspendStatusCounts(java.lang.String description,
                                                java.lang.String logName)

 
                 Suspend counting on ALL status counters--both public/global and private.
              
                 Suspends all status counting that is triggered via ApplicationUtilities.
                 See ApplicationUtilities for more information on counters.

Supporting Engines:

Rational Robot
SAFS TIDDriverCommands
Mercury Interactive WinRunner
OpenQA Selenium

Parameters:: description - Optional:YES Any additional information for suspending status counts.; logName - Optional:YES DefaultVal:MainLog (Future) The name of a Log Facility other than the "current" one.

suspendStatusCounts
```
public static DriverCommand suspendStatusCounts(java.lang.String[] parameters)
```
```
 
                 Suspend counting on ALL status counters--both public/global and private.
              
                 Suspends all status counting that is triggered via ApplicationUtilities.
                 See ApplicationUtilities for more information on counters.
                  
```
Supporting Engines:
- Rational Robot
- SAFS TIDDriverCommands
- Mercury Interactive WinRunner
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

Class DDDriverCounterCommands

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DELETECOUNTER_KEYWORD

LOGCOUNTERINFO_KEYWORD

RESETCOUNTER_KEYWORD

RESUMESTATUSCOUNTS_KEYWORD

SETCOUNTERMODE_KEYWORD

STARTCOUNTER_KEYWORD

STARTCYCLE_KEYWORD

STARTPROCEDURE_KEYWORD

STARTREQUIREMENT_KEYWORD

STARTSUITE_KEYWORD

STARTTESTCASE_KEYWORD

STOPCOUNTER_KEYWORD

STOPCYCLE_KEYWORD

STOPPROCEDURE_KEYWORD

STOPREQUIREMENT_KEYWORD

STOPSUITE_KEYWORD

STOPTESTCASE_KEYWORD

STORECOUNTERINFO_KEYWORD

SUSPENDSTATUSCOUNTS_KEYWORD

Method Detail

getInstance

deleteCounter

deleteCounter

logCounterInfo

logCounterInfo

resetCounter

resetCounter

resumeStatusCounts

resumeStatusCounts

setCounterMode

setCounterMode

startCounter

startCounter

startCycle

startCycle

startProcedure

startProcedure

startRequirement

startRequirement

startSuite

startSuite

startTestcase

startTestcase

stopCounter

stopCounter

stopCycle

stopCycle

stopProcedure

stopProcedure

stopRequirement

stopRequirement

stopSuite

stopSuite

stopTestcase

stopTestcase

storeCounterInfo

storeCounterInfo

suspendStatusCounts

suspendStatusCounts