NOK (OKW - OpenKeyWord 0.0.16 API)

java.lang.Object
- okw.core.NOK

All Implemented Interfaces:: IOKW_State

public class NOK
extends Object
implements IOKW_State

Constructor Summary

Constructors
Constructor and Description

NOK(Core fp_OKW)

Constructors
Constructor and Description
`NOK(Core fp_OKW)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`BeginTest(String fpsTestname)` \copydoc IOKW_State::BeginTest(String)
`void`	`ClickOn(String FN)` \copydoc IOKW_State::ClickOn(String)
`void`	`CopyFile(String fpsSourcePathAndFileName, String fpsDestinationPathAndFileName)`
`void`	`DoubleClickOn(String FN)` \copydoc IOKW_State::DoubleClickOn(String)
`void`	`EndTest()` \copydoc IOKW_State::EndTest()
`void`	`FileDelete(String fpsPathAndFileName)` \~german \brief Löscht die gegebene Datei.
`void`	`LogCaption(String FN)` \copydoc IOKW_State::LogCaption(String)
`void`	`LogExists(String FN)` \copydoc IOKW_State::LogExists(String)
`void`	`LogHasFocus(String FN)` \copydoc IOKW_State::LogHasFocus(String)
`void`	`LogIsActive(String FN)` \copydoc IOKW_State::LogIsActive(String)
`void`	`LogLabel(String FN)` \copydoc IOKW_State::LogLabel(String)
`void`	`LogSelected(String FN)` \copydoc IOKW_State::LogSelected(String)
`void`	`LogTablecellValue(String FN, String fpsCol, String fpsRow)` \copydoc IOKW_State::LogTablecellValue(String,String,String)
`void`	`LogTooltip(String FN)` \copydoc IOKW_State::LogTooltip(String)
`void`	`LogValue(String FN)` \copydoc IOKW_State::LogValue(String)
`void`	`MemorizeCaption(String FN, String fpsMemKeyName)` \copydoc IOKW_State::MemorizeCaption(String,String)
`void`	`MemorizeExists(String FN, String fpsMemKeyName)` \copydoc IOKW_State::MemorizeExists(String,String)
`void`	`MemorizeHasFocus(String FN, String fpsMemKeyName)` \copydoc IOKW_State::MemorizeHasFocus(String,String)
`void`	`MemorizeIsActive(String FN, String fpsMemKeyName)` \copydoc IOKW_State::MemorizeIsActive(String,String)
`void`	`MemorizeLabel(String FN, String fpsMemKeyName)` \copydoc IOKW_State::MemorizeLabel(String,String)
`void`	`MemorizeSelectedValue(String FN, String fpsMemKeyName)` \copydoc IOKW_State::MemorizeSelectedValue(String,String)
`void`	`MemorizeTablecellValue(String FN, String fpsCol, String fpsRow, String fpsMemKeyName)` \copydoc IOKW_State::MemorizeTablecellValue(String,String,String,String)
`void`	`MemorizeTooltip(String FN, String fpsMemKeyName)` \copydoc IOKW_State::MemorizeTooltip(String,String)
`void`	`MemorizeValue(String FN, String fpsMemKeyName)` \copydoc IOKW_State::MemorizeLabel(String,String)
`void`	`Select(String FN, String fpsValue)` \copydoc IOKW_State::Select(String,String)
`void`	`SelectMenu(String FN)` \copydoc IOKW_State::SelectMenu(String)
`void`	`SelectMenu(String FN, String fpsValue)` \copydoc IOKW_State::SelectMenu(String,String)
`void`	`SelectTablecell(String FN, String fpsCol, String fpsRow)` \copydoc IOKW_State::SelectTablecell(String,String,String)
`void`	`SelectWindow(String FN)` \copydoc IOKW_State::SelectWindow(String)
`void`	`Sequence(String FN, String SeqName, String SEQ_ID)` \copydoc IOKW_State::Sequence(String,String,String)
`void`	`SetFocus(String FN)` /// \copydoc IOKW_State::SetFocus(String)
`void`	`SetLanguage(String Language)` \~german \brief Interne Methode zum setzen der Sprache für die sprachabhängigen Ausgaben der Dokumentation (Log).
`void`	`SetValue(String FN, String fpsValue)` \copydoc IOKW_State::SetValue(String,String)
`void`	`StartApp(String fpsApplicationName)` \copydoc IOKW_State::StartApp(String)
`void`	`StopApp(String fpsApplicationName)` \copydoc IOKW_State::StopApp(String)
`void`	`TypeKey(String FN, String fpsValue)` \copydoc IOKW_State::TypeKey(String,String)
`void`	`TypeKeyTablecell(String FN, String fpsCol, String fpsRow, String fpsValue)` \copydoc IOKW_State::TypeKeyTablecell(String,String,String,String)
`void`	`TypeKeyWindow(String FN, String fpsValue)` \copydoc IOKW_State::TypeKeyWindow(String,String)
`void`	`VerifyCaption(String FN, String ExpVal)` \copydoc IOKW_State::VerifyCaption(String,String)
`void`	`VerifyCaptionREGX(String FN, String ExpVal)` \copydoc IOKW_State::VerifyCaption(String,String)
`void`	`VerifyCaptionWCM(String FN, String ExpVal)` \copydoc IOKW_State::VerifyCaption(String,String)
`void`	`VerifyDirectoryExists(String fpsPath, String ExpVal)` \~german \brief Prüft, ob das gegebene Verzeichnis existiert.
`void`	`VerifyExists(String FN, String ExpVal)` \copydoc IOKW_State::VerifyExists(String,String)
`void`	`VerifyFileExists(String fpsPathAndFileName, String ExpVal)` \~german \brief Prüft, ob die gegebene Datei existiert.
`void`	`VerifyHasFocus(String FN, String ExpVal)` \copydoc IOKW_State::VerifyHasFocus(String,String)
`void`	`VerifyIsActive(String FN, String ExpVal)` \copydoc IOKW_State::VerifyIsActive(String,String)
`void`	`VerifyLabel(String FN, String ExpVal)` \copydoc IOKW_State::VerifyValue(String,String)
`void`	`VerifyLabelREGX(String FN, String ExpVal)` \copydoc IOKW_State::VerifyLabelREGX(String,String)
`void`	`VerifyLabelWCM(String FN, String ExpVal)` \copydoc IOKW_State::VerifyLabelWCM(String,String)
`void`	`VerifySelectedValue(String FN, String ExpVal)` \copydoc IOKW_State::VerifySelectedValue(String,String)
`void`	`VerifyTablecellValue(String FN, String fpsCol, String fpsRow, String ExpVal)` \copydoc IOKW_State::VerifyTablecellValue(String,String,String,String)
`void`	`VerifyTooltip(String FN, String ExpVal)` \copydoc IOKW_State::VerifyTooltip(String,String)
`void`	`VerifyTooltipREGX(String FN, String ExpVal)` \copydoc IOKW_State::VerifyTooltipREGX(String,String)
`void`	`VerifyTooltipWCM(String FN, String ExpVal)` \copydoc IOKW_State::VerifyTooltipWCM(String,String)
`void`	`VerifyValue(String FN, String ExpVal)` /// \copydoc IOKW_State::VerifyValue(String,String)
`void`	`VerifyValueREGX(String FN, String ExpVal)` \copydoc IOKW_State::VerifyValueREGX(String,String)
`void`	`VerifyValueWCM(String FN, String ExpVal)` \copydoc IOKW_State::VerifyValueWCM(String,String)

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

- Constructor Detail
  - NOK
```
public NOK(Core fp_OKW)
```
- Method Detail
  - BeginTest
```
public void BeginTest(String fpsTestname)
```
    \copydoc IOKW_State::BeginTest(String)
    
    Specified by:
    
    BeginTest in interface IOKW_State
    
    Parameters:
    fpsTestname - Name oder Bezeichnung des Testfalls. \~english \brief Begins a test. Description of the allgorithm \note Keyword initalis
  - ClickOn
```
public void ClickOn(String FN)
```
    \copydoc IOKW_State::ClickOn(String)
    
    Specified by:
    
    ClickOn in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Clicks on given object. _Example: Click on the object with the name "My Object":_
    \verbatim click on: "MyObject" \endverbatim
  - DoubleClickOn
```
public void DoubleClickOn(String FN)
```
    \copydoc IOKW_State::DoubleClickOn(String)
    
    Specified by:
    
    DoubleClickOn in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Clicks on given object. _Example: Click on the object with the name "My Object":_
    \verbatim DoubleClickOn( "MyObject" ) \endverbatim
  - EndTest
```
public void EndTest()
```
    \copydoc IOKW_State::EndTest()
    
    Specified by:
    
    EndTest in interface IOKW_State
  - LogCaption
```
public void LogCaption(String FN)
```
    \copydoc IOKW_State::LogCaption(String)
    
    Specified by:
    
    LogCaption in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief No description for "LogCaption" available
  - LogExists
```
public void LogExists(String FN)
```
    \copydoc IOKW_State::LogExists(String)
    
    Specified by:
    
    LogExists in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Logs whether the given object is existing. _Example: Logs whether the object with the name "My Object" is existing:_
    \verbatim log exists: "MyObject" \endverbatim
  - LogHasFocus
```
public void LogHasFocus(String FN)
```
    \copydoc IOKW_State::LogHasFocus(String)
    
    Specified by:
    
    LogHasFocus in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Logs the focus status of the given object. _Example: Logs the focus status of "My Object":_
    \verbatim LoghasFocus: "MyObject" \endverbatim
  - LogIsActive
```
public void LogIsActive(String FN)
```
    \copydoc IOKW_State::LogIsActive(String)
    
    Specified by:
    
    LogIsActive in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Logs the status of the given object. _Example: Logs the active status of "My Object":_
    \verbatim LogIsActive: "MyObject" \endverbatim
  - LogLabel
```
public void LogLabel(String FN)
```
    \copydoc IOKW_State::LogLabel(String)
    
    Specified by:
    
    LogLabel in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief No description for "LogLabel" available
  - LogSelected
```
public void LogSelected(String FN)
```
    \copydoc IOKW_State::LogSelected(String)
    
    Specified by:
    
    LogSelected in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Logs the marked text of the given object.
  - LogTablecellValue
```
public void LogTablecellValue(String FN,
                     String fpsCol,
                     String fpsRow)
```
    \copydoc IOKW_State::LogTablecellValue(String,String,String)
    
    Specified by:
    
    LogTablecellValue in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsCol - Spaltennummer der zu wählenden Zelle, beginnend mit 1.
    fpsRow - Zeilennummer der zu wählenden Zelle, beginnend mit 1. \~english \brief Logs the value of the selected tablecell.
  - LogTooltip
```
public void LogTooltip(String FN)
```
    \copydoc IOKW_State::LogTooltip(String)
    
    Specified by:
    
    LogTooltip in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Logs the Tooltip of the given object. _Example: Logs the tooltip text of "My Object":_
    \verbatim LogToolip: "MyObject" \endverbatim
  - LogValue
```
public void LogValue(String FN)
```
    \copydoc IOKW_State::LogValue(String)
    
    Specified by:
    
    LogValue in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Logs the standard value of an object. The standard value of the object (in most cases the visible text) is detected and returned in the actual log-file
    _Example: Check if the value (text) of object "MyObject" equals the expected value "Django":_
    \verbatim Verify Value: "MyObject", "Django" \endverbatim
  - MemorizeCaption
```
public void MemorizeCaption(String FN,
                   String fpsMemKeyName)
```
    \copydoc IOKW_State::MemorizeCaption(String,String)
    
    Specified by:
    
    MemorizeCaption in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsMemKeyName - Name des Schlüssels \~english \brief No description for "MemorizeCaptione" available
  - MemorizeExists
```
public void MemorizeExists(String FN,
                  String fpsMemKeyName)
```
    \copydoc IOKW_State::MemorizeExists(String,String)
    
    Specified by:
    
    MemorizeExists in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsMemKeyName - Name des Schlüssels \~english \brief Memorizes the actual existing Status of the object. The value is stored under the key returned as parameter.
    _Example: Memorizes the existent state of the object "My Object" under the key "My Key":_
    \verbatim Memorize Exists: "MyObject", "MyKey" \endverbatim
  - MemorizeHasFocus
```
public void MemorizeHasFocus(String FN,
                    String fpsMemKeyName)
```
    \copydoc IOKW_State::MemorizeHasFocus(String,String)
    
    Specified by:
    
    MemorizeHasFocus in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsMemKeyName - Name des Schlüssels \~english \brief No description for "MemorizeHasFocus" available
  - MemorizeIsActive
```
public void MemorizeIsActive(String FN,
                    String fpsMemKeyName)
```
    \copydoc IOKW_State::MemorizeIsActive(String,String)
    
    Specified by:
    
    MemorizeIsActive in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsMemKeyName - Name des Schlüssels \~english \brief Memorizes the state of the given object. The value is stored under the key which is given as parameter.
    _Example Memorizes the object-state of MyObject under the key "MyKey":_
    \verbatim Memorize Is Active: "MyObject", "MyKey" \endverbatim
  - MemorizeLabel
```
public void MemorizeLabel(String FN,
                 String fpsMemKeyName)
```
    \copydoc IOKW_State::MemorizeLabel(String,String)
    
    Specified by:
    
    MemorizeLabel in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsMemKeyName - Name des Schlüssels \~english \brief No description for "MemorizeLabel" available
  - MemorizeSelectedValue
```
public void MemorizeSelectedValue(String FN,
                         String fpsMemKeyName)
```
    \copydoc IOKW_State::MemorizeSelectedValue(String,String)
    
    Specified by:
    
    MemorizeSelectedValue in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsMemKeyName - Name des Schlüssels \~english \brief No description for "MemorizeSelectedValue" available
  - MemorizeTablecellValue
```
public void MemorizeTablecellValue(String FN,
                          String fpsCol,
                          String fpsRow,
                          String fpsMemKeyName)
```
    \copydoc IOKW_State::MemorizeTablecellValue(String,String,String,String)
    
    Specified by:
    
    MemorizeTablecellValue in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsCol - Spaltennummer der zu wählenden Zelle, beginnend mit 1.
    fpsRow - Zeilennummer der zu wählenden Zelle, beginnend mit 1. \~english \brief Memorizes the value of the given tablecell.
    fpsMemKeyName - Name des Schlüssels
  - MemorizeTooltip
```
public void MemorizeTooltip(String FN,
                   String fpsMemKeyName)
```
    \copydoc IOKW_State::MemorizeTooltip(String,String)
    
    Specified by:
    
    MemorizeTooltip in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsMemKeyName - Name des Schlüssels \~english \brief Logs the tooltip-text of the given object. _Example logs the tooltip text of the given object "my object"_
    \verbatim Logge Tooltip: "MeinObjekt" \endverbatim
  - MemorizeValue
```
public void MemorizeValue(String FN,
                 String fpsMemKeyName)
```
    \copydoc IOKW_State::MemorizeLabel(String,String)
    
    Specified by:
    
    MemorizeValue in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsMemKeyName - Name des Schlüssels \~english \brief Memorizes the standard value of an object. The standard value of the object -mostly this is the displayed text- is picked out and stored under the internal given key. The value can read out with the keyword XXXXX after it.
    _Example Memorizes the value (text) of object "MyObject" under the key "MyKey":_
    \verbatim Memorize the value (text) of object "MyObject" under the key "MyKey" \endverbatim
  - Select
```
public void Select(String FN,
          String fpsValue)
```
    \copydoc IOKW_State::Select(String,String)
    
    Specified by:
    
    Select in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsValue - Sich ergebender Wert \~english \brief Select all rows in a list/chart, which contain the given data. Chart columns are merged row by row to process lists and charts identical. The first row which contains the given data will be selected. The row is selected by a single click. The delivery of an additional parameter "Doubleclick" leads to the use of a doubleclick. The {HSEP}-constant can be used, if defined values in multiple columns are required.
    _Example #1: Select all rows which contain the text "Value":_
    \verbatim Select: "MyTable", "Value" \endverbatim
    _Example #2: Select all rows which contain the text "Value1" in the first column, followed by the text "Value2" in any of the remaining columns:_
    \verbatim Select: "MyTable", "Value1{HSEP}Value2" \endverbatim
    _Example #3: Select all rows which contain the text "Value1", followed by any (or no) text in the first column, followed by an empty column, followed by the text "Value2" in the third column:_
    \verbatim Select: "MyTable", "Value1{HSEP}{HSEP}Value2" \endverbatim
  - SelectMenu
```
public void SelectMenu(String FN)
```
    \copydoc IOKW_State::SelectMenu(String)
    
    Specified by:
    
    SelectMenu in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Selects the given menu item. _Example Select menu item with name "MyMenu":_
    \verbatim Select menu: "MyMenu" \endverbatim
  - SelectMenu
```
public void SelectMenu(String FN,
              String fpsValue)
```
    \copydoc IOKW_State::SelectMenu(String,String)
    
    Specified by:
    
    SelectMenu in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsValue - Sich ergebender Wert \~english \brief Selects the given menu item. _Example Select menu item with name "MyMenu":_
    \verbatim Select menu: "MyMenu" \endverbatim
  - SelectTablecell
```
public void SelectTablecell(String FN,
                   String fpsCol,
                   String fpsRow)
```
    \copydoc IOKW_State::SelectTablecell(String,String,String)
    
    Specified by:
    
    SelectTablecell in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsCol - Spaltennummer der zu wählenden Zelle, beginnend mit 1.
    fpsRow - Zeilennummer der zu wählenden Zelle, beginnend mit 1. \~english \brief Selects the given table cell. The column and row positions are always entered as strings. If such a parameter is starting with a hash (#) the String is interpreted as an index number, e.g. "#1"). If a hash sign should be interpreted as text it must signed with a backslash, e.g. "\#1 text with leading number"). The header row is addressed with the index "0". The first data row starts with the index 1. For tables with multiline headers the offset to the first data row can be set The column index starts with the number 1.
    _Example #1: Select cell at first column with text "Toni" and row with number 3:_
    \verbatim Select Tablecell: "MyTable", "Toni", "#3" \endverbatim _Example #2: Select cell at column with number 1 and row with name "Address":_
    \verbatim Select Tablecell: "MyTable", "#1", "Address" \endverbatim _Example #3: Select cell at column number 1 and row 1:_
    \verbatim Select Tablecell: "MyTable", "#1", "#1" \endverbatim _Example #4: Select cell at col number 1 and first row with text "42":_
    \verbatim Select Tablecell: "MyTable", "#1", "42" \endverbatim
  - SelectWindow
```
public void SelectWindow(String FN)
```
    \copydoc IOKW_State::SelectWindow(String)
    
    Specified by:
    
    SelectWindow in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Setting the context for the given window and ensuring that the window is active and in the foreground. _Example: Select window with name "MyWindow":_
    \verbatim Select Window: "MyWindow" \endverbatim
  - Sequence
```
public void Sequence(String FN,
            String SeqName,
            String SEQ_ID)
```
    \copydoc IOKW_State::Sequence(String,String,String)
    
    Specified by:
    
    Sequence in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Fensterobjekts, in der die Sequenz definiert ist.
    SeqName - Name der Sequenz, die aufgerufen werden soll.
    SEQ_ID - Sequenz ID des Datensatzes, die als Eingabe verwendet werden soll. \~english \brief Calls the sequence of the window. Sequences are defined per window and have a unique sequence name within the window. Entered records are referenced with the sequence ID. _Example: Calling the sequence _Login_ of the window _Login_ with the record _Administrator_:_
    \verbatim Sequence: "Login", "Login" = "Administrator" \endverbatim
  - SetFocus
```
public void SetFocus(String FN)
```
    /// \copydoc IOKW_State::SetFocus(String)
    
    Specified by:
    
    SetFocus in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts \~english \brief Setting the focus to the given window object.
  - SetLanguage
```
public void SetLanguage(String Language)
```
    Description copied from interface: IOKW_State
    
    \~german \brief Interne Methode zum setzen der Sprache für die sprachabhängigen Ausgaben der Dokumentation (Log). Die auswählbaren Sprachen sind in OKWLanguage::cvLsLanguagesImplemented definiert und werden mit dieser Liste abgeprüft.
    
    Specified by:
    
    SetLanguage in interface IOKW_State
    
    Parameters:
    Language - Sprache die ausgewählt werden soll, z.B. mit "de" \~english \brief Internal method to set the language of the language depending outputs of the log documentation. The choosable languages are defined in OKWLanguage::cvLsLanguagesImplemented and are prooved with this list.
  - SetValue
```
public void SetValue(String FN,
            String fpsValue)
```
    \copydoc IOKW_State::SetValue(String,String)
    
    Specified by:
    
    SetValue in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsValue - Sich ergebender Wert \~english \brief Setting the value of the given window object to the given value. The input is not working with the simulation of single keyboard inputs, but with High-Level Setter-Methods of the objects:
    Inputs of the object are written over with "Val". _Example: Set the value of the objekt "MyWindow" to "Hello":_
    \verbatim Set Value: "Name", "Zoltan" \endverbatim
  - StartApp
```
public void StartApp(String fpsApplicationName)
```
    \copydoc IOKW_State::StartApp(String)
    
    Specified by:
    
    StartApp in interface IOKW_State
    
    Parameters:
    fpsApplicationName - Der fachliche Name der Anwendung. \~english \brief Starts the given application. _Example: Order to start the application "InternetExplorer":_
    \verbatim Start Application: "InternetExplorer"\endverbatim \remark Te method "StartApp()" must be implemented in the class "fpsApplikatioName". The technical identifier must not inevitably be identical to the name of the exe file: here we hav e a mapping between the technical identifier and the invoked "*.exe"
    An example how a full Implementation can look at, is to be find in SeInternetExplorerApp.StartApp
  - StopApp
```
public void StopApp(String fpsApplicationName)
```
    \copydoc IOKW_State::StopApp(String)
    
    Specified by:
    
    StopApp in interface IOKW_State
    
    Parameters:
    fpsApplicationName - Derf achliche Name der Anwendung \~english \brief Ends a given application. _Example: Order to start the application "InternetExplorer":_
    \verbatim End Application: "InternetExplorer"\endverbatim \remark The method "StopApp()" must be implemented in the class "fpsApplikatioName" The framework is not able to know, how a specific application is to be closed. The must be fully implemented specific to the project.
    An example, how the full implementation can look at is to be find at SeInternetExplorerApp.StopApp.
  - TypeKey
```
public void TypeKey(String FN,
           String fpsValue)
```
    \copydoc IOKW_State::TypeKey(String,String)
    
    Specified by:
    
    TypeKey in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsValue - Sich ergebender Wert \~english \brief Keyboard inputs of data in the active windows object. The data are sent as keyboard inputs to the child object of the active window. This enables the use of hot keys and function keys as input data. If with help of the valueseparator (SEP) multiple values are passed in the parameter, then all values are sent as keyboard input to the window object, separated by a line break. __Example: "Simple Input":__
    \verbatim Type Key: "MyWindowObjekt", "InputValue" \endverbatim __Example: "Input of constant value":__
    \verbatim Type Key: "MainWindow", "{F2}" \endverbatim __Example: "Input of more than one value":__
    \verbatim Type Key: "MyWindowObjekt", "InputValue1{SEP}InputValue2" \endverbatim
  - TypeKeyTablecell
```
public void TypeKeyTablecell(String FN,
                    String fpsCol,
                    String fpsRow,
                    String fpsValue)
```
    \copydoc IOKW_State::TypeKeyTablecell(String,String,String,String)
    
    Specified by:
    
    TypeKeyTablecell in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsCol - Spaltennummer der zu wählenden Zelle, beginnend mit 1. \~english \brief Input of date to a given tablecell by the keyboard. The data are sent as keyboard inputs to the given tablecell. This ensures the use of hotkeys and functional tabs as input data. The parameters of the row and column positions are always set as strings. If such a parameter is starting with a hash (#) the String is interpreted as an index number, e.g. "#1"). If a hash sign should be interpreted as text it must signed with a backslash, e.g. "\#1 text with leading number"). The header row is adressed with the index "0". The first data row starts with the index 1. For tables with multiline headers the offset to the first data row can be set The column index starts with the number 1.
    _Example #1: Simple Input in cell at column 2 and row 5:_
    \verbatim Type Key Tablecell: "MyTable", 2, 5, "InputValue" \endverbatim _Example #2: Simple Input in cell at first column with text "Toni" and row with name "Tester":_
    \verbatim Type Key Tablecell: "MyTable", "Toni", "Tester", "InputValue" \endverbatim _Example #3: Simple Input in cell at first column with text "Toni" and row with number 3:_
    \verbatim Type Key Tablecell: "MyTable", "Toni", 3, "InputValue" \endverbatim _Example #4: Simple Input in cell at column with number 1 and row with name "Address":_
    \verbatim Type Key Tablecell: "MyTable", 1, "Address", "InputValue" \endverbatim _Example #5: Input of constant value named "F2" in cell at column number 1 and row 1:_
    \verbatim Type Key Tablecell: "MyTable", 1, 1, "{F2}" \endverbatim _Example #6: Input of more than one value in cell at first column with text "Ernie" and third row:_
    \verbatim Type Key Tablecell: "MyTable", "Ernie", 3, "InputValue1{SEP}InputValue2" \endverbatim _Example #7: Input of value "Hiho" into cell at column number 1 and first row with text "42":_
    \verbatim Type Key Tablecell: "MyTable", "#1", "42", "HiHo" \endverbatim
    fpsRow - Zeilennummer der zu wählenden Zelle, beginnend mit 1.
    fpsValue - Sich ergebender Wert
  - TypeKeyWindow
```
public void TypeKeyWindow(String FN,
                 String fpsValue)
```
    \copydoc IOKW_State::TypeKeyWindow(String,String)
    
    Specified by:
    
    TypeKeyWindow in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsValue - Sich ergebender Wert \~english \brief Keyboard input to a particular window object. The data will be sent as keyboard inputs to the window object. This ensures the use of hotkeys an functional keys as input data. Multiple values can be given as input by help of the constant {SEP} (see examples). The values are divided with tabstops with the input.
    _Example #1: Simple Input:_
    \verbatim Type Key Window: "MyWindowObjekt", "InputValue" \endverbatim _Example #2: Input of constant value:_
    \verbatim Type Key Window: "MainWindow", "{F2}" \endverbatim _Example #3: Input of more than one value:_
    \verbatim Type Key Window: "MyWindowObjekt", "InputValue1{SEP}InputValue2" \endverbatim
  - VerifyCaption
```
public void VerifyCaption(String FN,
                 String ExpVal)
```
    \copydoc IOKW_State::VerifyCaption(String,String)
    
    Specified by:
    
    VerifyCaption in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief No description for "VerifyCaption" available
  - VerifyCaptionWCM
```
public void VerifyCaptionWCM(String FN,
                    String ExpVal)
```
    \copydoc IOKW_State::VerifyCaption(String,String)
    
    Specified by:
    
    VerifyCaptionWCM in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief No description for "VerifyCaption" available
  - VerifyCaptionREGX
```
public void VerifyCaptionREGX(String FN,
                     String ExpVal)
```
    \copydoc IOKW_State::VerifyCaption(String,String)
    
    Specified by:
    
    VerifyCaptionREGX in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief No description for "VerifyCaption" available
  - VerifyExists
```
public void VerifyExists(String FN,
                String ExpVal)
```
    \copydoc IOKW_State::VerifyExists(String,String)
    
    Specified by:
    
    VerifyExists in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief Checks the existence of the given object.
    _Example #1: Check if the object MyObject exists:_
    \verbatim Verify Exists: "MyObject", "YES" \endverbatim _Example #2: Check if the object MyObject does not exist:_
    \verbatim Verify Exists: "MyObject", "NO" \endverbatim
  - VerifyHasFocus
```
public void VerifyHasFocus(String FN,
                  String ExpVal)
```
    \copydoc IOKW_State::VerifyHasFocus(String,String)
    
    Specified by:
    
    VerifyHasFocus in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert. Erlaubte Werte sind: "JA", "NEIN" und "IGNORIEREN". \~english \brief Compares the focus status of the given object with the expected value. _Example #1: Verify if the object MyObject has the focus:_
    \verbatim Verify Has Focus: "MyObject", "YES" \endverbatim _Example #2: Verify if the object MyObject has NOT the focus:_
    \verbatim Verify Has Focus: "MyObject", "NO" \endverbatim
  - VerifyIsActive
```
public void VerifyIsActive(String FN,
                  String ExpVal)
```
    \copydoc IOKW_State::VerifyIsActive(String,String)
    
    Specified by:
    
    VerifyIsActive in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert. Erlaubte Werte sind: "JA", "NEIN" und "IGNORIEREN". \~english \brief Compares the focus status of the given object with the expected value. _Example: Verify if the object MyObject is in the state "active":_
    \verbatim Verify Is Active: "MyObject", "YES" \endverbatim
  - VerifyLabel
```
public void VerifyLabel(String FN,
               String ExpVal)
```
    \copydoc IOKW_State::VerifyValue(String,String)
    
    Specified by:
    
    VerifyLabel in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief Verifies the Label of a GUI-object.
  - VerifyLabelWCM
```
public void VerifyLabelWCM(String FN,
                  String ExpVal)
```
    \copydoc IOKW_State::VerifyLabelWCM(String,String)
    
    Specified by:
    
    VerifyLabelWCM in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief Verifies the Label of a GUI-object.
  - VerifyLabelREGX
```
public void VerifyLabelREGX(String FN,
                   String ExpVal)
```
    \copydoc IOKW_State::VerifyLabelREGX(String,String)
    
    Specified by:
    
    VerifyLabelREGX in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief Verifies the Label of a GUI-object.
  - VerifySelectedValue
```
public void VerifySelectedValue(String FN,
                       String ExpVal)
```
    \copydoc IOKW_State::VerifySelectedValue(String,String)
    
    Specified by:
    
    VerifySelectedValue in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief Compares the selected value of the given listobject with the expected value. A list can be a simple list, a table or a tree-view. Expected Values in tree-views are indicated with the whole hierarchy (see example). With this the hierarchical elements are divided with the separator {SEP}.
    _Example #1: Check if the list entry "Henry" is selected in the list "MyList":_
    \verbatim Verify Selected Value: "MyList", "Henry" \endverbatim _Example #2: Check if the entry "Names{SEP}Henry" is selected in the treeview "MyTreeview":_
    \verbatim Verify Selected Value: "MyTreeview", "Names{SEP}Henry" \endverbatim
  - VerifyTablecellValue
```
public void VerifyTablecellValue(String FN,
                        String fpsCol,
                        String fpsRow,
                        String ExpVal)
```
    \copydoc IOKW_State::VerifyTablecellValue(String,String,String,String)
    
    Specified by:
    
    VerifyTablecellValue in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    fpsCol - Spaltennummer der zu wählenden Zelle, beginnend mit 1. \~english \brief Compares the content of the given table cell with the expected value.
    fpsRow - Zeilennummer der zu wählenden Zelle, beginnend mit 1.
    ExpVal - Erwarteter Wert
  - VerifyTooltip
```
public void VerifyTooltip(String FN,
                 String ExpVal)
```
    \copydoc IOKW_State::VerifyTooltip(String,String)
    
    Specified by:
    
    VerifyTooltip in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief Checks the tooltip-text of an object. The expected value is exactly, i.e. without wildcards, specified.
  - VerifyTooltipWCM
```
public void VerifyTooltipWCM(String FN,
                    String ExpVal)
```
    \copydoc IOKW_State::VerifyTooltipWCM(String,String)
    
    Specified by:
    
    VerifyTooltipWCM in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert als Wildcardmatch. \~english \brief Checks the tooltip text of an object. The expected Value is givan as WildCardMatch The following wildcards can be used: * "?" - exactly one character is masked * "*" - (0-n) any number of characters to be masked * "#" - exactly one number [0..9] is masked _Example: Check if the tooltip text of object "MyObject" equals the expected value "?jango":_
    \verbatim VerifyTooltipWCM( "MyObject", "?jango" ) \endverbatim
  - VerifyTooltipREGX
```
public void VerifyTooltipREGX(String FN,
                     String ExpVal)
```
    \copydoc IOKW_State::VerifyTooltipREGX(String,String)
    
    Specified by:
    
    VerifyTooltipREGX in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert, gegegebn als Regulärerausdruck. \~english \brief Checks the tooltip-text of an object. The expected tooltip text is givan as Regularexpression. _Example: Check if the tooltip text of object "MyObject" equals the expected tooltip text "\\.jango":_
    \verbatim VerifyTooltipREGX( "MyObject", "\\.jango" ) \endverbatim
  - VerifyValue
```
public void VerifyValue(String FN,
               String ExpVal)
```
    /// \copydoc IOKW_State::VerifyValue(String,String)
    
    Specified by:
    
    VerifyValue in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief Checks the standard value of an object (in most cases this is the displayed text). The expected value is exactly, i.e. without wildcards, specified. _Example: Check if the value (text) of object "MyObject" equals the expected value "Django":_
    \verbatim VerifyValue( "MyObject", "Django" ) \endverbatim
  - VerifyValueWCM
```
public void VerifyValueWCM(String FN,
                  String ExpVal)
```
    \copydoc IOKW_State::VerifyValueWCM(String,String)
    
    Specified by:
    
    VerifyValueWCM in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert / Sollwert. \~english \brief Checks the standard value of an object (in most cases this is the displayed text). The expected Value is givan as Regularexpression The following wildcards can be used: * "?" - exactly one character is masked * "*" - (0-n) any number of characters to be masked * "#" - exactly one number [0..9] is masked _Example: Check if the value (text) of object "MyObject" equals the expected value "Django":_
    \verbatim VerifyValueWCM( "MyObject", "Django" ) \endverbatim
  - VerifyValueREGX
```
public void VerifyValueREGX(String FN,
                   String ExpVal)
```
    \copydoc IOKW_State::VerifyValueREGX(String,String)
    
    Specified by:
    
    VerifyValueREGX in interface IOKW_State
    
    Parameters:
    FN - Funktionaler Name des Objekts
    ExpVal - Erwarteter Wert \~english \brief Checks the standard value of an object (in most cases this is the displayed text). The expected Value is givan as Regularexpression _Example: Check if the value (text) of object "MyObject" equals the expected value "Django":_
    \verbatim VerifyValueREGX( "MyObject", "$Django" ) \endverbatim
  - FileDelete
```
public void FileDelete(String fpsPathAndFileName)
```
    Description copied from interface: IOKW_State
    
    \~german \brief Löscht die gegebene Datei. In der Pfadangabe sind - OKW-Parser angaben sind erlaubt ${umgebungsvariable}, ${merkewertschlüssel}. - im Dateinamen sind Wildcards * + ? erlaubt. \note Dieses Schlüsselwort stellt sicher, dass _nach_ der Ausführung die angegebene Datei oder Dateien nicht (mehr) existiert/existieren. Falls die gegebene Datei _nicht_ existiert, dann wird _ohne Fehlermeldung_ und auslösen einer Ausnahme das Schlüsselwort beendet. \par Beispiel DE.LöscheDatei( "C:\temp\meineDatei.txt" ) - Löscht die Datei meineDatei.txt im Verzeichniss C:\temp DE.LöscheDatei( "C:\temp\*.*" ) - Löscht alle Dateien im Verzeichniss C:\temp \par Siehe auch - DE::LöscheDatei(string) - EN::FileDelete(string) - Core::FileDelete(string) - OK::FileDelete(string) - NOK::FileDelete(string) - OK_TRY::FileDelete(string) - NOK_TRY::FileDelete(string) - IOKW_State::FileDelete(string)
    
    Specified by:
    
    FileDelete in interface IOKW_State
    
    Parameters:
    fpsPathAndFileName - Vollständiger Pfad und Dateiname. \~english \brief Deletes the given file. If the file does not exist, then this keyword ends without error message and an exception will not rais. - OKW-Parser is included. - widcards are in the filename allowed.
  - VerifyFileExists
```
public void VerifyFileExists(String fpsPathAndFileName,
                    String ExpVal)
```
    Description copied from interface: IOKW_State
    
    \~german \brief Prüft, ob die gegebene Datei existiert.
    
    Specified by:
    
    VerifyFileExists in interface IOKW_State
    
    Parameters:
    fpsPathAndFileName - Pfad und Name der Datei, die Geprüft werden soll
    ExpVal - Erwarteter Wert. Möglich Werte sind: "JA"/"NEIN"/"${IGNORIERE}" /exception OKWFileDoesNotExistsException Wenn die gegeben Datei ein Verzeichniss ist, also eben keine Datei, dann wird ein OKWFileDoesNotExistsException ausgelöst. \~english \brief
  - VerifyDirectoryExists
```
public void VerifyDirectoryExists(String fpsPath,
                         String ExpVal)
```
    Description copied from interface: IOKW_State
    
    \~german \brief Prüft, ob das gegebene Verzeichnis existiert.
    
    Specified by:
    
    VerifyDirectoryExists in interface IOKW_State
    
    ExpVal - Erwarteter Wert. Möglich Werte sind: "JA"/"NEIN"/"${IGNORIERE}" \~english \brief
  - CopyFile
```
public void CopyFile(String fpsSourcePathAndFileName,
            String fpsDestinationPathAndFileName)
```
    Specified by:
    
    CopyFile in interface IOKW_State

Class NOK

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NOK

Method Detail

BeginTest

ClickOn

DoubleClickOn

EndTest

LogCaption

LogExists

LogHasFocus

LogIsActive

LogLabel

LogSelected

LogTablecellValue

LogTooltip

LogValue

MemorizeCaption

MemorizeExists

MemorizeHasFocus

MemorizeIsActive

MemorizeLabel

MemorizeSelectedValue

MemorizeTablecellValue

MemorizeTooltip

MemorizeValue

Select

SelectMenu

SelectMenu

SelectTablecell

SelectWindow

Sequence

SetFocus

SetLanguage

SetValue

StartApp

StopApp

TypeKey

TypeKeyTablecell

TypeKeyWindow

VerifyCaption

VerifyCaptionWCM

VerifyCaptionREGX

VerifyExists

VerifyHasFocus

VerifyIsActive

VerifyLabel

VerifyLabelWCM

VerifyLabelREGX

VerifySelectedValue

VerifyTablecellValue

VerifyTooltip

VerifyTooltipWCM

VerifyTooltipREGX

VerifyValue

VerifyValueWCM

VerifyValueREGX

FileDelete

VerifyFileExists

VerifyDirectoryExists

CopyFile