okw.core.IOKW_State Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Show all versions of core Show documentation
This is the core-module of OpenKeyWord. This module is automatically integrated by the adapters. In GUI automation, the core module is automatically integrated by the GUI modules (dependencies).
/*
==============================================================================
Copyright © 2012 - 2018 IT-Beratung Hrabovszki
==============================================================================
This file is part of OpenKeyWord.
OpenKeyWord is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenKeyWord is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OpenKeyWord. If not, see
* \verbatim EN.ClickOn( "MeinObjekt" ) \endverbatim
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Clicks on given object.
*
* _Example: Click on the object with the name "My Object":_
* \verbatim Click On: "MyObject" \endverbatim
*
* @param FN Functional name of the object
*
* _Example: Click on "My Object":_
*
* \verbatim EN.ClickOn( "MyObject" ) \endverbatim
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-18
* @throws Exception
*/
void ClickOn( String FN ) throws Exception;
/** \~german
* Führt ein Doppelklick auf das gegebene GUI-Objekt aus.
*
* _Beispiel: Klicke auf das Objekt mit Namen "MeinObjekt":_
* \verbatim DoppelKlickeAuf( "MeinObjekt" ) \endverbatim
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Clicks on given object.
*
* _Example: Click on the object with the name "My Object":_
* \verbatim DoubleClickOn( "MyObject" ) \endverbatim
*
* @param FN Functional Name of the object
*
* \~
* @author [email protected]
* @date 2014-09-18
* @throws Exception
*/
void DoubleClickOn( String FN ) throws Exception;
/**
* \~german
* Signalisiert das Ende eines Testfalls.
*
* Mit EndTest() werden aufräum Aktivitäten angestoßem,
* in der aktuellen Version ist das jedoch noch nicht implementiert.
*
* \note Zusätzliche Bemerkungen zum Schlüsselwort
*
*
* \~english
* Terminates the test respectively the testcase.
*
* Description of the mode of operation.
* \note Additional remark to the keyword
*
*
* \~
* @author [email protected]
* @date 2014-09-18
* @throws Exception
*/
void EndTest() throws Exception;
/**
* \~german
* Gibt die \ref refCaption eines GUI-Objektes in den Testergebnissen aus.
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* No description for "LogCaption" available
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-18/jnic
* \todo jnic-->keine Beschreibung vorhanden
*/
void LogCaption( String FN ) throws Exception;
/**
* \~german
* Gibt die Existenz eines GUI-Objektes mit YES/NO in den Testergebnissen aus.
*
* _Beispiel: Protokolliert, ob das Objekt mit Namen "Mein Objekt" vorhanden ist:_
* \verbatim LogExists( "myObject" ) \endverbatim
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Logs whether the given object is existing.
*
* _Example: Logs whether the object with the name "My Object" is existing:_
* \verbatim log exists: "MyObject" \endverbatim
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-18
*/
void LogExists( String FN ) throws Exception;
/**
* \~german
* Dokumentiert den Fokus-Status des gegebenen Objekts.
*
* _Beispiel: Protokolliert den Fokus-Zustand von "Mein Objekt":_
* \verbatim Logge hat Fokus: "MeinObjekt" \endverbatim
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Logs the focus status of the given object.
*
* _Example: Logs the focus status of "My Object":_
* \verbatim LoghasFocus: "MyObject" \endverbatim
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void LogHasFocus( String FN ) throws Exception;
/**
* \~german
* Dokumentiert den Status des gegebenen Objekts.
*
* _Beispiel: Protokolliert den Aktivzustand von "Mein Objekt":_
* \verbatim LoggeIstAktiv: "MeinObjekt" \endverbatim
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Logs the status of the given object.
*
* _Example: Logs the active status of "My Object":_
* \verbatim LogIsActive: "MyObject" \endverbatim
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void LogIsActive( String FN ) throws Exception;
/**
* \~german
* Gibt den Wert des Etikette/Label in der Logdatei aus.
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Displays the value of the label in the log file.
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void LogLabel( String FN ) throws Exception;
/**
* \~german
* Gibt den Wert des Platzhalters in der Logdatei aus.
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Displays the value of the placeholder in the log file.
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void LogPlaceholder( String FN ) throws Exception;
/**
* \~german
* Dokumentiert den markierten Text des gegebenen Objekts.
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Logs the marked text of the given object.
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void LogSelected( String FN ) throws Exception;
/**
* \~german
* Dokumentiert den Wert der ausgewählten Zelle.
*
* @param FN Funktionaler Name des Objekts
* @param COL Spaltennummer der zu wählenden Zelle, beginnend mit 1.
* @param ROW Zeilennummer der zu wählenden Zelle, beginnend mit 1.
*
* \~english
* \brief
* Logs the value of the selected tablecell.
*
* @param FN Functional name of the object
* @param COL Column number of cell to be selected, starting with 1.
* @param ROW Row number of cell to be selected, starting with 1.
*
* \~
* @author [email protected]
* @date 2014-09-19
* \todo Beschreibung überprüfen
*/
void LogTablecellValue( String FN, String COL, String ROW ) throws Exception;
/**
* \~german
* Dokumentiert die Kurzinfo zu einem Werkzeug des gegebenen Objekts.
*
* _Beispiel: Protokolliert den Kurzinformationstext (Tooltip) von "Mein Objekt":_
* \verbatim LoggeTooltip: "MeinObjekt" \endverbatim
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Logs the Tooltip of the given object.
*
* _Example: Logs the tooltip text of "My Object":_
* \verbatim LogToolip: "MyObject" \endverbatim
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void LogTooltip( String FN ) throws Exception;
/**
* \~german
* Dokumentiert den Standartwert eines Objekts.
*
* Der Standardwert des Objektes (in den meisten Fällen ist dies der angezeigte Text)
* wird ausgelesen und in der aktuellen Dokumentationsdatei ausgegeben.
* _Beispiel: Prüfe, ob der Wert (Text) des Objekts "MeinObjekt" dem erwarteten Wert "Django" entspricht:_
* \verbatim Prüfe Wert: "MeinObjekt", "Django" \endverbatim
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* 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
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void LogValue( String FN ) throws Exception;
/**
* \~german
* Keine Beschreibung zu "MemorizeCaption" verfügbar
*
* @param FN Funktionaler Name des Objekts
* @param fpsMemKeyName Name des Schlüssels
*
* \~english
* No description for "MemorizeCaptione" available
*
* @param FN Functional name of the object
* @param fpsMemKeyName Name of the key
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void MemorizeCaption( String FN, String fpsMemKeyName ) throws Exception;
/**
* \~german
* Merkt sich den aktuell existierenden Zustand des Objekts.
*
* Der Wert wird unter dem als Parameter übergebenen Schlüssel gespeichert.
* _Beispiel: Merkt sich den vorhandenen Zustand des Objektes "MeinObjekt" unter dem
* Schlüssel "Mein Schlüssel".:_
* \verbatim Merke Existiert: "MeinObjekt", "Mein Schlüssel" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param 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
*
* @param FN Functional name of the object
* @param fpsMemKeyName Name of the key
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void MemorizeExists( String FN, String fpsMemKeyName ) throws Exception;
/**
* \~german
* Keine Beschreibung zu "MemorizeHasFocus" verfügbar
*
* @param FN Funktionaler Name des Objekts
* @param fpsMemKeyName Name des Schlüssels
*
* \~english
* No description for "MemorizeHasFocus" available
*
* @param FN Functional name of the object
* @param fpsMemKeyName Name of the key
*
* \~
* @author [email protected]
* @date 2014-09-19/jnic
* @todo TODO: keine Beschreibung vorhanden
*/
void MemorizeHasFocus( String FN, String fpsMemKeyName ) throws Exception;
/**
* \~german
* Merkt sich den Zustand des gegebenen Objekts.
*
* Der Wert wird unter dem als Parameter übergebenen Schlüssel gespeichert.
* _Beispiel: Merkt den Zustand des Objektes "MeinObjekt" unter dem Schlüssel "Mein Schlüssel":_
* \verbatim Merke Ist Aktiv: "MeinObjekt", "Mein Schlüssel" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param fpsMemKeyName Name des Schlüssels
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param fpsMemKeyName Name of the key
*
* \~
* @author [email protected]
* @date TODO: 2014-09-19
*/
void MemorizeIsActive( String FN, String fpsMemKeyName ) throws Exception;
/**
* \~german
* Speirchert den aktuellen Wert der Etikette, und legt diesen unter fpsMemKeyName ab.
*
* @param FN Funktionaler Name des Objekts
* @param fpsMemKeyName Name des Schlüssels
*
* \~english
* Speaks the current value of the label and stores it under fpsMemKeyName.
*
* @param FN Functional name of the object
* @param fpsMemKeyName Name of the key
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void MemorizeLabel( String FN, String fpsMemKeyName ) throws Exception;
/**
* \~german
* Speirchert den aktuellen Wert der Platzhalters, und legt diesen unter fpsMemKeyName ab.
*
* @param FN Funktionaler Name des Objekts
* @param fpsMemKeyName Name des Schlüssels
*
* \~english
* Saves the current value of the label, and saves it under fpsMemKeyName.
*
* @param FN Functional name of the object
* @param fpsMemKeyName Name of the key
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void MemorizePlaceholder( String FN, String fpsMemKeyName ) throws Exception;
/**
* \~german
* Keine Beschreibung zu "MemorizeSelectedValue" verfügbar
*
* @param FN Funktionaler Name des Objekts
* @param fpsMemKeyName Name des Schlüssels
*
* \~english
* No description for "MemorizeSelectedValue" available
*
* @param FN Functional name of the object
* @param fpsMemKeyName Name of the key
*
* \~
* @author [email protected]
* @date 2014-09-19/jnic
* @todo TODO:keine Beschreibung vorhanden
*/
void MemorizeSelectedValue( String FN, String fpsMemKeyName ) throws Exception;
/**
* \~german
* Merkt sich den Wert der gegebenen Zelle in der Tabelle.
*
* @param FN Funktionaler Name des Objekts
* @param fpsMemKeyName Name des Schlüssels
* @param COL Spaltennummer der zu wählenden Zelle, beginnend mit 1.
* @param ROW Zeilennummer der zu wählenden Zelle, beginnend mit 1.
*
* \~english
* Memorizes the value of the given tablecell.
*
* @param FN Functional name of the object
* @param fpsMemKeyName Name of the key
* @param COL Column number of cell to be selected, starting with 1.
* @param ROW Row number of cell to be selected, starting with 1.
*
* \~
* @author [email protected]
*/
void MemorizeTablecellValue( String FN, String COL, String ROW, String fpsMemKeyName ) throws Exception;
/**
* \~german
* Dokumentiert den Tooltip-Text (Kurzinformation) des gegebenen Objekts.
*
* _Beispiel Dokumentiert den Tooltip-Text des Objektes "MeinObjekt":_
* \verbatim Logge Tooltip: "MeinObjekt" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param fpsMemKeyName Name des Schlüssels
*
* \~english
* Logs the tooltip-text of the given object.
*
* _Example logs the tooltip text of the given object "my object"_
* \verbatim Logge Tooltip: "MeinObjekt" \endverbatim
*
* @param FN Functional name of the object
* @param fpsMemKeyName Name of the key
*
* \~
* @author [email protected]
* @date 2014-09-19/jnic
*/
void MemorizeTooltip( String FN, String fpsMemKeyName ) throws Exception;
/**
* \~german
* Merkt sich den Standartwert eines Objekts.
*
* Der Standartwert des Objektes (in den meisten Fällen ist dies der angezeigte Text)
* wird ausgelesen und intern unter dem übergebenen Schlüssel gespeichert. Der Wert kann
* danach mit dem Schlüsselwort XXXXX wieder ausgelesen werden.
* _Beispiel: Legt sich den Wert (Text) des Objekts "MeinObjekt" unter dem Schlüssel "MeinSchlüssel" ab:_
* \verbatim Merke Wert: "MeinObjekt", "MeinSchlüssel" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param fpsMemKeyName Name des Schlüssels
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param fpsMemKeyName Name of the key
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void MemorizeValue( String FN, String fpsMemKeyName ) throws Exception;
/**
* \~german
* Auswahl aller Zeilen einer Liste/Tabelle, welche die gegebenen Daten enthalten.
*
* Tabellenspalten werden zeilenweise zusammengefasst, so dass Listen und Tabellen identisch verarbeitet
* werden. Die erste Zeile, welche die gegebenen Daten enthält, wird ausgewählt. Die
* Zeile wird über einen einfachen Klick angewählt. Die Übergabe des zusätzlichen Parameters
* "Doppelklick" führt zur Verwendung eines Doppelklicks.
* Die {HSEP}-Konstante kann verwendet werden, wenn definierte Werte in mehreren
* Spalten gefordert sind.
* _Beispiel 1: Wähle alle Zeilen aus, die den Text "Wert" enthalten:_
* \verbatim Wähle aus: "MeineTabelle", "Wert" \endverbatim
*
* _Beispiel 2: Wähle alle Zeilen aus, die mit dem Text "Wert1" beginnen und
* deren zweite Spalte den Text "Wert2" enthält:_
* \verbatim Wähle aus: "MeineTabelle", "Wert1{HSEP}, Wert2" \endverbatim
*
* _Beispiel 3: Wähle alle Zeilen aus, die mit dem Text "Wert1" beginnen und
* deren dritte Spalte den Text "Wert2" enthält:_
* \verbatim Wähle aus: "MeineTabelle", "Wert1{HSEP}{HSEP}Wert2" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param Val Sich ergebender Wert
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param Val Resulting value
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void Select( String FN, String Val ) throws Exception;
/**
* \~german
* Wählt den gegebenen Menü-Eintrag aus
*
* _Beispiel: Wähle Menüeintrag mit Namen "MeinMenü":_
* \verbatim Wähle Aus Menü: "MeinMenü" \endverbatim
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Selects the given menu item.
*
* _Example Select menu item with name "MyMenu":_
* \verbatim Select menu: "MyMenu" \endverbatim
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014.09.19
*/
void SelectMenu( String FN ) throws Exception;
/**
* \~german
* Wählt den gegebenen Menüeintrag aus.
*
* _Beispiel: Wähle Menüeintrag mit Namen "MeinMenü":_
* \verbatim Wähle Aus Menü: "MeinMenü" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param Val Sich ergebender Wert
*
* \~english
* Selects the given menu item.
*
* _Example Select menu item with name "MyMenu":_
* \verbatim Select menu: "MyMenu" \endverbatim
*
* @param FN Functional name of the object
* @param Val Resulting value
*
* \~
* @author [email protected]
* @date 2014.09.19
*/
void SelectMenu( String FN, String Val ) throws Exception;
/**
* \~german
* Wählt die gegebene Tabellenzelle aus.
*
* Die Parameter für die Spalten- und Zeilenpositionen werden immer als Strings eingegeben.
* Wenn ein Positionsparameter mit einem Hash (#) beginnt, dann wird er als Zahl interpretiert, z.B. "#1".
* Wenn das Hashzeichen als Text interpretiert werden soll, dann muss dies über einen vorangestellten
* Backslash gekennzeichnet werden, z.B. "#1 Text mit vorangestellter Nummer".
*
* Die Kopfzeile der Tabelle wird über den Index "0" angesprochen. Die erste Datenzeile beginnt
* mit dem Index 1. Für Tabellen mit mehrzeiligen Kopfzeilen kann im Objekt selbst der Offset
* zur ersten Datenzeile festgelegt werden. Der Spaltenindex beginnt mit der Nummer 1.
* _Beispiel 1: Auswahl der Zelle in Spalte 2 und Zeile 5:_
* \verbatim Wähle aus Tabellenzelle: "MeineTabelle", "#2", "#5" \endverbatim
* _Beispiel 2: Auswahl der Zelle in erster Spalte mit Text "Toni" und Zeile mit dem Namen "Tester":_
* \verbatim Wähle aus Tabellenzelle: "MeineTabelle", "Toni", "Tester" \endverbatim
* _Beispiel 3: Auswahl der Zelle in erster Spalte mit Text "Toni" und Zeile 3:_
* \verbatim Wähle aus Tabellenzelle: "MeineTabelle", "Toni", "#3" \endverbatim
* _Beispiel 4: Auswahl der Zelle in Spalte 1 und erster Zeile mit Text "42":_
* \verbatim Wähle aus Tabellenzelle: "MeineTabelle", "#1", "42" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param COL Spaltennummer der zu wählenden Zelle, beginnend mit 1.
* @param ROW Zeilennummer der zu wählenden Zelle, beginnend mit 1.
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param COL Column number of cell to be selected, starting with 1.
* @param ROW Row number of cell to be selected, starting with 1.
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void SelectTablecell( String FN, String COL, String ROW ) throws Exception;
/**
* \~german
* Setzt den Kontext auf das gegebene Fenster.
*
* Das Fenster wird aktiviert und in den Vordergrund geholt.
* Alle nachfolgen GUI-Schlüssleworte (z.B. Gib ein) beziehen sich auf das gegeben Fenster.
* Der Kontext wechselt erst mit dem nächsten _Wähle aus Fenster_ auf ein anderes Fenster.
*
* \todo zh: jnic die englische Beschreibung für Selectwindow anpassen.
*
* _Beispiel: Auswahl des Fensters mit dem Namen "MeinFenster":_
* \verbatim Wähle aus Fenster: "MeinFenster" \endverbatim
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* 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
*
* @param FN Functionalname of the object
*
* \~
* @author [email protected]
* @date 2014-09-19
*/
void SelectWindow( String FN ) throws Exception;
/**
* \~german
* Setzt den Wert von SELECTEDCHILD auf den Wert von FN.
*
* In nachfolgenden OpeKeywords kann dieser Wert mit "SELECTEDCHILD" abgerufen bzw referenziert werden.
*
* _Beispiel:_ Auswahl des Kindobjektes mit dem Namen "MeinKindobjekt"
* \code{java}
* EN.SelectChild( "MeinKindobjekt" )
* EN.SetValue("SELECTEDCHILD", "MyValue")
* EN.VerifyValue("SELECTEDCHILD", "MyValue")
* EN.VerifyLabel("SELECTEDCHILD", "MyLabel")
* \endcode
*
* @param FN Funktionaler Name des KindObjektes
*
* \~english
* Sets the value of SELECTEDCHILD to the value of FN.
*
* In the following OpeKeywords this value can be retrieved or referenced with "SELECTEDCHILD".
*
* _Example:_ Selection of the child object with the name "MyChildObject".
* \code{java}
* EN.SelectChild( "MeinKindobjekt" ) name, vormane
* EN.SetValue("SELECTEDCHILD", "MyValue")
* EN.VerifyLenght("SELECTEDCHILD", "MyValue") 1, 2 ,5, 5
* EN.VerifyLabel("SELECTEDCHILD", "MyLabel")
* \endcode
*
* @param FN Functional Name of the object
*
* \~
* @author [email protected]
* @date 2018-10-02
*/
void SelectChild( String FN ) throws Exception;
/**
* \~german
* Setzt den Context auf FN.
*
* SelectContext() ist wie SelectWindow(String) zu verwenden. Der Unterschied zu SelectWindow(String) ist, dass SelectContext(String) keine
* Interaktionen, wie Existenzprüfung oder Fenster in den Vordergrund holen, auslöst. Technisch wird lediglich das Frame mit
* dem gegebenen Namen ausgewählt.
*
* _Beispiel:_
* \code{java}
* EN.SelectContext( "Login" )
* EN.SetValue("User", "MyUser")
* EN.SetValue("Password", "MyPassword")
* EN.ClickOn("OK")
* \endcode
*
* @param FN Funktionaler Name des Parentobjektes
*
* \~english
* Sets the context to FN.
*
* SelectContext() is to be used like SelectWindow(String).
* The difference to SelectWindow(String) is that SelectContext(String)
* does not trigger any interactions, such as existence check or bringing windows to the foreground.
* Technically, only the frame with the given name is selected.
*
* _Example:_
* \code{java}
* EN.SelectContext( "Login" )
* EN.SetValue("User", "MyUser")
* EN.SetValue("Password", "MyPassword")
* EN.ClickOn("OK")
* \endcode
*
* @param FN Functional Name of parent object
*
* \~
* @author [email protected]
* @date 2018-10-02
*/
void SelectContext( String FN ) throws Exception;
/** \~german
* Ruft die Sequenz eines Fensters auf.
*
* Sequenzen sind je Fenster definiert und haben innerhalb des Fenster einen eindeutigen Sequenznamen.
* Einzugebende Datensätze werden mit der Sequenz-ID referenziert.
*
* _Beispiel: Aufrufen der Sequenz _Anmelden_ des Fensters _Login_ mit dem Datensatz _Administrator_:_
* \verbatim Sequenz: "Login", "Anmelden" = "Administrator" \endverbatim
*
* @param FN Funktionaler Name des Fensterobjekts, in der die Sequenz definiert ist.
* @param fpsSequenceName Name der Sequenz, die aufgerufen werden soll.
* @param SEQ_ID Sequenz ID des Datensatzes, die als Eingabe verwendet werden soll.
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param fpsSequenceName No explanation available
* @param SEQ_ID No explanation available
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void Sequence( String FN, String fpsSequenceName, String SEQ_ID ) throws Exception;
/**
* \~german
* Setzt den Fokus auf das gegebene Fensterobjekt.
*
* @param FN Funktionaler Name des Objekts
*
* \~english
* Setting the focus to the given window object.
*
* @param FN Functional name of the object
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void SetFocus( String FN ) throws Exception;
/**
* \~german
* 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.
*
* @param Language Sprache die ausgewählt werden soll, z.B. mit "de"
*
* \~english
* 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.
*
* @param Language Select "en"
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void setLanguage( String Language );
/**
* \~german
* Setzt den Wert des gegebenen Fensterobjekts auf den gegebenen Wert.
*
* Der Wert wird nicht durch die Simulation einzelner Tastatureingaben
* eingegeben, sondern direkt ins Objekte geschrieben:
* Sollte z.B. in einem TextFeld bereits ein Wert vorhanden sein,
* dann wird dieser mit _fpsValue_ überschrieben.
*
* __Beispiel:__ Setze den Wert des Objekts "MeinObjekt" auf "Hallo":
* \verbatim Setze Wert: "Name", "Zoltan" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param Val Sich ergebender Wert
*
* \~english
* 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 EN.SetValue( "Name", "Zoltan" ) \endverbatim
*
* @param FN Functional name of the object
* @param Val Resulting value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void SetValue( String FN, String Val ) throws Exception;
/**
* \~german
* Setzt den Wert der gegebenen Variablen VN auf den gegebenen Wert Val.
*
* __Beispiel:__ Setze den Wert der Variablen "myVar" auf den Wert "myValue":
* \verbatim EN.SetVar( "myVar", "myValue" ) \endverbatim
*
* Die Variable kann nun in den Schlüsselwörter Werten verwendet werden:
*
* \verbatim EN.SetValue( "myObject", "${myVar}" ) \endverbatim
*
* @param VN Name der Var, die du definieren möchtest
* @param Val Wert, der dem Var-Namen zuzuordnen ist.
*
* \~english
* Sets the value of the given variable VN to the given value Val.
*
* __Example:__ Set the value of the variable "myVar" to the value "myValue":
* \verbatim EN.SetVar( "myVar", "myValue" ) \endverbatim
*
* @param VN Var Name: Name of the Var you vant to define
* @param Val Value to be assinged to the Var Name
*
* \~
* @author [email protected]
* @date 2019-11-26
*/
void SetVar( String VN, String Val ) throws Exception;
/**
* \~german
* Startet die gegebene Anwendung.
*
* _Beispiel: Befehl zum Starten der Anwendung "InternetExplorer":_
* \verbatim Starte Anwendung: "InternetExplorer"\endverbatim
*
* \remark Die Methode "StartApp()" muss in der Klasse "fpsApplikatioName"
* implementiert werden. Der fachliche Bezeichner muss nicht zwangsläufing
* mit dem Namen der Exe-Datei übereinstimmen: Hier findet ein Mapping/Zuordnung
* zwischen fachlichen Bezeichner und der aufzurufenden "*.exe" statt.
* Ein Beispiel, wie eine Ausimplementierung aussehen kann, ist
* in SeInternetExplorerApp.StartApp zu finden.
*
* @param fpsApplicationName Der fachliche Name der Anwendung.
*
* \~english
* 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
*
* @param fpsApplicationName No explanation available
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void StartApp( String fpsApplicationName ) throws Exception;
/**
* \~german
* Beendet eine gegebene Anwendung.
*
* _Beispiel: Befehl zum Starten der Anwendung "InternetExplorer":_
* \verbatim Beende Anwendung: "InternetExplorer"\endverbatim
*
* \remark Die Methode "StopApp()" muss in der Klasse "fpsApplikatioName"
* implementiert werden. Das Framework kann nicht wissen, wie eine spezielle Anwendung
* beendet werden muss. Das muss projektspezifisch ausimplementiert werden.
* Ein Beispiel, wie eine Ausimplementierung aussehen kann, ist in SeInternetExplorerApp.StopApp zu finden.
*
* @param 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.
*
* @param fpsApplicationName The technical name of the application
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void StopApp( String fpsApplicationName ) throws Exception;
/**
* \~german
* Tastatureingaben von Daten in das aktive Fensterobjekt.
*
* Die Daten werden als Tastureingaben an das Kindobjekt des aktiven Fenters
* gesendet. Dies ermöglicht die Verwendung von Hotkeys und Funktionstasten als
* Eingabedaten. Wenn mit Hilfe des Wertseparators {SEP} mehrere Werte im Parameter
* übergeben werden, dann werden alle Werte als Tastatureingabe an das Fensterobjekt
* gesendet, getrennt durch einen Zeilenumbruch.
*
* __Beispiel "Einfache Eingabe":__
* \verbatim Gib ein: "MeinFensterObjekt", "EingabeWert" \endverbatim
*
* __Beispiel "Eingabe einer Konstanten":__
* \verbatim Gib ein: "MeinFensterObjekt", "{F2}" \endverbatim
*
* __Beispiel "Eingabe mehrerer Werte":__
*
* \verbatim Gib ein: "MeinFensterObjekt", "Eingabewert1{SEP}Eingabewert2" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param Val Sich ergebender Wert
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param Val Resulting value
*
* \~
* @author [email protected]
* @date 2014-09-21/jnic
*/
void TypeKey( String FN, String Val ) throws Exception;
/**
* \~german
* Eingabe von Daten in eine gegebene Tabellenzelle über die Tastatur.
*
* Die Daten werden als Tastureingaben an die gegebene Zelle einer Tabelle gesendet.
* Dies ermöglicht die Verwendung von Hotkeys (Schnellzugang)und Funktionstasten als Eingabedaten.
* Die Parameter für die Spalten- und Zeilenpositionen werden immer als Strings eingegeben.
* Wenn ein Positionsparameter mit einem Hash (#) beginnt, dann wird er als Zahl interpretiert, z.B. "#1".
* Wenn das Hashzeichen als Text interpretiert werden soll, dann muss dies über einen vorangestellten
* Backslash gekennzeichnet werden, z.B. "#1 Text mit vorangestellter Nummer".
* Die Kopfzeile der Tabelle wird über den Index "0" angesprochen.
* Die erste Datenzeile beginnt mit dem Index 1.
* Für Tabellen mit mehrzeiligen Kopfzeilen kann im Objekt selbst der Offset zur ersten Datenzeile festgelegt werden.
* Der Spaltenindex beginnt mit der Nummer 1.
* _Beispiel 1: Einfache Eingabe in Zelle an Spalte 2 und Zeile 5:_
* \verbatim Gib ein Tabellenzelle: "MeineTabelle", 2, 5, "Eingabewert" \endverbatim
* _Beispiel 2: Einfache Eingabe in Zelle an erster Spalte mit Text "Toni"
* und Zeile mit dem Namen "Tester":_
* \verbatim Gib ein Tabellenzelle: "MeineTabelle", "Toni", "Tester", "Eingabewert" \endverbatim
* _Beispiel 3: Einfache Eingabe in Zelle an erster Spalte mit Text "Toni" und Zeile 3:_
* \verbatim Gib ein Tabellenzelle: "MeineTabelle": "MeineTabelle", "Toni", 3, "Eingabewert" \endverbatim
* _Beispiel 4: Einfache Eingabe in Zelle an Spalte 1 und Zeile mit Namen "Adresse":_
* \verbatim Gib ein Tabellenzelle: "MeineTabelle", 1, "Adresse", "Eingabewert" \endverbatim
* _Beispiel 5: Eingabe der Konstanten "F2" in Zelle an Spalte 1 und Zeile 1:_
* \verbatim Gib ein Tabellenzelle: "MeineTabelle", 1, 1, "{F2}" \endverbatim
* _Beispiel 6: Eingabe mehrerer Werte in Zelle an erster Spalte mit Test "Ernie" und Zeile 3:_
* \verbatim Gib ein Tabellenzelle: "MeineTabelle", "Ernie", 3, "Wer1{SEP}Wert2" \endverbatim
* _Beispiel 7: Eingabe des Wertes "HiHo" in Zelle an Spalte 1 und erster Zeile mit Text "42":_
* \verbatim Gib ein Tabellenzelle: "MeineTabelle", "#1", "42", "HiHo" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param Val Sich ergebender Wert
* @param ROW Zeilennummer der zu wählenden Zelle, beginnend mit 1.
* @param COL Spaltennummer der zu wählenden Zelle, beginnend mit 1.
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param ROW Row number of cell to be selected, starting with 1.
* @param COL Column number of cell to be selected, starting with 1.
* @param Val Resulting value
*
* \~
* @author [email protected]
* @date 2014-09-21/jnic
*/
void TypeKeyTablecell( String FN, String COL, String ROW, String Val ) throws Exception;
/**
* \~german
* @brief
* Tastatureingabe in ein bestimmtes Fensterobjekt.
*
* Die Daten werden als Tastureingaben an das Fensterobjekt gesendet.
* Dies ermöglicht die Verwendung von Hotkeys (Schnellzugang) und Funktionstasten als Eingabedaten.
* Mehrere Werte können mit Hilfe der Konstanten {SEP} eingegeben werden (siehe Beispiele).
* Die Werte werden dann bei der Eingabe durch Zeilenumbrüche getrennt.
* _Beispiel 1: Einfache Eingabe:_
* \verbatim Gib ein Fenster: "MeinFensterObjekt", "EingabeWert" \endverbatim
* _Beispiel 2: Eingabe einer Konstanten:_
* \verbatim Gib ein Fenster: "MeinFensterObjekt", "{F2}" \endverbatim
* _Beispiel 3: Eingabe mehrerer Werte:_Beispiel
* \verbatim Gib ein Fenster: "MeinFensterObjekt", "Eingabewert1{SEP}Eingabewert2" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param Val Einzugebender gebender 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
*
* @param FN Functional name of the object
* @param Val Resulting value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void TypeKeyWindow( String FN, String Val ) throws Exception;
/**
* \~german
* Überprüft den Badge des Objektes .
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Verifies the Badge of a GUI-object.
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* \~
* @author Daniel Krüger
* @date 2019-04-04
*/
void VerifyBadge( String BN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft den Badge des Objektes .
* Mit Wildcard-Match
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Verifies the Badge of a GUI-object.
* with Wildcard-Match
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* \~
* @author Daniel Krüger
* @date 2019-04-04
*/
void VerifyBadgeWCM( String BN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft den Badge des Objektes .
* Mit RegulererAusdruck
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Verifies the Badge of a GUI-object.
* with regular expression
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* \~
* @author Daniel Krüger
* @date 2019-04-04
*/
void VerifyBadgeREGX( String BN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft die Überschrift des Objektes.
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* No description for "VerifyCaption" available
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21/jnic
* \todo TODO: keine Beschreibung vorhanden
*/
void VerifyCaption( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft die Überschrift des Objektes.
* Der Sollwert wird als Wildcard-Match angegeben.
*
* Folgende Platzhalter sind möglich:
* * "?" - genau ein beliebiges Zeichen wird Maskiert
* * "*" - (0-n) beliebiges Zeichen wird Maskiert
* * "#" - genau eine Ziffer [0..9] kann maskiert werden
* _Beispiel: Prüfe, ob der Wert (Text) des Objekts "MeinObjekt" dem erwarteten
* Wert "\\.jango" entspricht:_
*
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* No description for "VerifyCaption" available
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21/jnic
* \todo TODO: keine Beschreibung vorhanden
*/
void VerifyCaptionWCM( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft die Überschrift eines Objektes, Reguläre-Ausdrücke als Sollwert sind erlaubt.
*
* _Beispiel:_ Prüfe, ob der Wert (Text) des Objekts "MeinObjekt" mit dem erwarteten Wert "Django" begint:
*
* \verbatim EN.VerifyCaptionREGX( "MeinObjekt", "^Django.*" ) \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Verifies the heading of an object, regular expressions are allowed as expected values.
*
* _Example:_ Check if the value (text) of the object "MyObject" starts with the expected value "Django":
*
* \verbatim EN.VerifyCaptionREGX( "myObject", "^Django.*" ) \endverbatim
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyCaptionREGX( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Prüft, ob das gegebene Objekt existiert.
*
* _Beispiel 1: Prüfe, ob das Objekt "MeinObjekt" existiert:_
* \verbatim Prüfe Existiert: "MeinObjekt", "JA" \endverbatim
* _Beispiel 2: Prüfe, ob das Objekt "MeinObjekt" nicht existiert:
* \verbatim Prüfe Existiert: "MeinObjekt", "NEIN" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyExists( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Vergleicht den Fokus-Zustand des gegebenen Objekts mit dem erwarteten Wert.
*
* _Beispiel 1: Prüfe, ob das Objekt "MeinObjekt" den Fokus besitzt:_
* \verbatim Prüfe Hat Fokus: "MeinObjekt", "JA" \endverbatim
* _Beispiel 2: Prüfe, ob das Objekt "MeinObjekt" den Fokus NICHT besitzt:_
* \verbatim Prüfe Hat Fokus: "MeinObjekt", "NEIN" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert. Erlaubte Werte sind: "JA", "NEIN" und "IGNORIEREN".
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param ExpVal Expected Value. Following values are Allowed here: "YES, "NO", and "IGNORE".
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyHasFocus( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Vergleicht den Fokus-Status des gegebenen Objekts mit dem erwarteten Wert.
*
* _Beispiel: Prüfe, ob das Objekt "MeinObjekt" sich im Status "aktiv" befindet:_
* \verbatim Prüfe Ist Aktiv: "MeinObjekt", "JA" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert. Erlaubte Werte sind: "JA", "NEIN" und "IGNORIEREN".
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param ExpVal Expected Value. Following values are allowed here: "YES, "NO", and "IGNORE".
*
* \~
* @author [email protected]
* @date 2014-09-21/jnic
*/
void VerifyIsActive( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft den Platzhalter des Objektes.
*
* _Beispiel: Prüfe, ob der Platzhalter (Text) des Objekts "MeinObjekt"
* dem erwarteten Wert "Django" übereinstimmt:_
*
* \verbatim EN.VerifyPlaceholderWCM( "MeinObjekt", "Django" ) \endverbatim
*
* @param FN Funktionaler Name des GUI-Objektes
* @param ExpVal Erwarteter Wert
*
* \~english
* Verifies the placeholder of a GUI-object.
*
* Example: Check whether the placeholder (text) of the object "MyObject" matches the expected value "Django":
*
* \verbatim EN.VerifyPlaceholderWCM: "MyObjekt", "Django" \endverbatim
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2018-10-03
*/
void VerifyPlaceholder( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Checks the maximum number of characters that can be entered.
*
* _Beispiel:_ Prüfe, ob max. 10 Zeichen in ein das Objekt mit FN = "Name"
* eingeben werden darf:
*
* \verbatim EN.VerifyMaxLength( "Name", "10" ) \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert, als String Zahl
*
* \~english
* Verifies the placeholder of a GUI-object.
*
* _Example:_ Check if max. 10 characters in the object with FN = "Name" can be inserted:
*
* \verbatim EN.VerifyMaxLength( "Name", "10" ) \endverbatim
*
* @param FN Functional name of the object
* @param ExpVal Expected Value as String with Numbers
*
* \~
* @author [email protected]
* @date 2018-12-25
*/
void VerifyMaxLength( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft den Platzhalter des Objektes.
* Wildcards sind im erwartetem Wert erlaubt.
*
* Folgende Wildcards sind möglich:
* * "?" - genau ein beliebiges Zeichen wird Maskiert
* * "*" - (0-n) beliebige Zeichen werden maskiert
* * "#" - genau eine Ziffer [0..9] kann maskiert werden
*
* _Beispiel: Prüfe, ob der Platzhalter (Text) des Objekts "MeinObjekt" dem erwarteten Wert "*jango" entspricht:_
*
* \verbatim VerifyPlaceholderWCM: "MeinObjekt", "*jango" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Verifies the placeholder of the GUI object.
* Wildcards are allowed in the expected value.
*
* The following wildcards are supported:
*
* * "?" - exactly one arbitrary character is masked
* * "*" - (0-n) any characters are masked
* * "#" - exactly one digit [0..9] can be masked
*
* _Example: Check whether the placeholder (text) of the object "MyObject" corresponds to the expected value "*jango:_
*
* \verbatim VerifyPlaceholderWCM: "MyObjekt", "*jango" \endverbatim
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2018-10-03
*/
void VerifyPlaceholderWCM( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft den Platzhalter des Objektes.
* Reguläre Ausdrücke als Sollwert sind erlaubt.
*
* _Beispiel: Prüfe, ob der Plathalter (Text) des Objekts "MeinObjekt" dem erwarteten
* Wert "\\.jango" entspricht:_
*
* \verbatim VerifyPlaceholderREGX: "MeinObjekt", "$Django" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Verifies the placeholder of the GUI object.
* Regular expressions as expected values are allowed.
*
* _Example: Check whether the placeholder (text) of the object "MyObject" corresponds to the expected value "\\.jango":_
*
* \verbatim VerifyPlaceholderREGX: "MyObjekt", "$Django" \endverbatim
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2018-10-03
*/
void VerifyPlaceholderREGX( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft die Beschreibung des Objektes.
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Verifies the label of a GUI-object.
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyLabel( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft die Beschreibung/Label des Objektes.
* Der Sollwert wird als Wildcard-Match angegeben.
*
* Folgende Platzhalter sind möglich:
* * "?" - genau ein beliebiges Zeichen wird Maskiert
* * "*" - (0-n) beliebiges Zeichen wird Maskiert
* * "#" - genau eine Ziffer [0..9] kann maskiert werden
* _Beispiel: Prüfe, ob der Wert (Text) des Objekts "MeinObjekt" dem erwarteten
* Wert "\\.jango" entspricht:_
*
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Verifies the Label of a GUI-object.
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyLabelWCM( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft die Überschrift des Objektes.
* Reguläre aus drücke als sollwert sind erlaubt.
*
* _Beispiel: Prüfe, ob der Wert (Text) des Objekts "MeinObjekt" dem erwarteten
* Wert "\\.jango" entspricht:_
*
* \verbatim PrüfeWertREGX: "MeinObjekt", "$Django" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Verifies the Label of a GUI-object.
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyLabelREGX( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Vergleicht den ausgewählten Wert des gegebenen Listenobjekts mit dem erwarteten Wert.
*
* Eine Liste ist eine einfache Liste, eine Tabelle oder eine Baumansicht.
* Bei erwarteten Werten in Baumansichten (Treeview) wird immer die gesamte Hierarchie
* angegeben (siehe Beispiel).
* Dabei werden die Hierarchie-Elemente über den Separator {SEP} getrennt.
* _Beispiel 1: Prüfe, ob das Element "Henry" in der Liste "MeineListe" ausgewählt ist:_
* \verbatim Prüfe Ausgewählter Wert: "MeineListe", "Henry" \endverbatim
* _Beispiel 2: Prüfe, ob das Element "Namen{SEP}Henry" in der Baumansicht "MeinTreeview" ausgewählt ist:_
* \verbatim Prüfe Ausgewählter Wert: "MeinTreeview", "Namen{SEP}Henry" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifySelectedValue( String FN, String ExpVal ) throws Exception;
/**
* @copydoc IOKW_State::VerifySelectedValue(String,String)
*/
void VerifySelectedValueWCM( String FN, String ExpVal ) throws Exception;
/**
* @copydoc IOKW_State::VerifySelectedValue(String,String)
*/
void VerifySelectedValueREGX( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Vergleicht den Inhalt der gegebenen Tabellenzelle mit dem erwarteten Wert.
*
* @param FN Funktionaler Name des Objekts
* @param COL Spaltennummer der zu wählenden Zelle, beginnend mit 1.
* @param ROW Zeilennummer der zu wählenden Zelle, beginnend mit 1.
* @param ExpVal Erwarteter Wert
*
* \~english
* Compares the content of the given table cell with the expected value.
*
* @param FN Functional name of the object
* @param COL Column number of cell to be selected, starting with 1.
* @param ROW Row number of cell to be selected, starting with 1.
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyTablecellValue( String FN, String COL, String ROW, String ExpVal ) throws Exception;
/**
* \~german
* Vergleicht den Inhalt der gegebenen Tabellenzelle mit dem erwarteten Wert.
*
* Der Sollwert wird als Wildcard-Match angegeben.
*
* Folgende Platzhalter sind möglich:
* * "?" - genau ein beliebiges Zeichen wird Maskiert
* * "*" - (0-n) beliebig viele Zeichen werden Maskiert
* * "#" - genau eine Ziffer [0..9] wird maskiert
*
* @param FN Funktionaler Name des Objekts
* @param COL Spaltennummer der zu wählenden Zelle, beginnend mit 1.
* @param ROW Zeilennummer der zu wählenden Zelle, beginnend mit 1.
* @param ExpVal Erwarteter Wert
*
* \~english
* Compares the content of the given table cell with the expected value.
*
* @param FN Functional name of the object
* @param COL Column number of cell to be selected, starting with 1.
* @param ROW Row number of cell to be selected, starting with 1.
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyTablecellValueWCM( String FN, String COL, String ROW, String ExpVal ) throws Exception;
/**
* \~german
* Vergleicht den Inhalt der gegebenen Tabellenzelle mit dem erwarteten Wert.
*
* Sollwert kann als Regulärer Ausdruck angegeben werden.
*
*
* @param FN Funktionaler Name des Objekts
* @param COL Spaltennummer der zu wählenden Zelle, beginnend mit 1.
* @param ROW Zeilennummer der zu wählenden Zelle, beginnend mit 1.
* @param ExpVal Erwarteter Wert
*
* \~english
* Compares the content of the given table cell with the expected value.
*
* @param FN Functional name of the object
* @param COL Column number of cell to be selected, starting with 1.
* @param ROW Row number of cell to be selected, starting with 1.
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/ void VerifyTablecellValueREGX( String FN, String COL, String ROW, String ExpVal ) throws Exception;
/** \~german
* Prüft den Tooltip-Text eines Objektes.
* Der Sollwert wird exakt, d.h ohne Platzhalter, angegeben.
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Checks the tooltip-text of an object.
* The expected value is exactly, i.e. without wildcards, specified.
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyTooltip( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Prüft den Standardwert eines Objektes (in den meisten Fällen ist dies der angezeigte Text).
* Der Sollwert wird als RegulererAusdruck angegeben.
*
* _Beispiel: Prüfe, ob der Tooltip-Text des Objekts "MeinObjekt" dem erwarteten
* Wert "\\.jango" entspricht:_
*
* \verbatim VerifyTooltipREGX( "MeinObjekt", "\\.jango" )\endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert, gegegebn als Regulärerausdruck.
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyTooltipREGX( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Prüft den Tooltip-Text eines Objektes (in den meisten Fällen ist dies der angezeigte Text).
* Der Sollwert wird als Wildcard-Match angegeben.
*
* Folgende Platzhalter sind möglich:
* * "?" - genau ein beliebiges Zeichen wird Maskiert
* * "*" - (0-n) beliebig viele Zeichen werden Maskiert
* * "#" - genau eine Ziffer [0..9] wird maskiert
*
* _Beispiel: Prüfe, ob der Tooltip Text des Objekts "MeinObjekt" dem erwarteten
* Wert "?jango" entspricht:_
*
* \verbatim PrüfeTooltipWCM: "MeinObjekt", "?jango" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert als Wildcardmatch.
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param ExpVal Expected Value as WildCardMatch
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyTooltipWCM( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Prüft den Standardwert eines Objektes (in den meisten Fällen ist dies der angezeigte Text).
*
* _Beispiel: Prüfe, ob der Wert (Text) des Objekts "MeinObjekt" dem erwarteten
* Wert "Django" entspricht:_
*
* \verbatim Prüfe Wert: "MeinObjekt", "Django" \endverbatim
*
* Dieses Schlüsselwort prüft die exakte Übereinstimmung. Wildkards sind nicht möglich.
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyValue( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Prüft den Standardwert eines Objektes (in den meisten Fällen ist dies der angezeigte Text).
* Der Sollwert wird als RegulererAusdruck angegeben.
*
* _Beispiel: Prüfe, ob der Wert (Text) des Objekts "MeinObjekt" dem erwarteten
* Wert "\\.jango" entspricht:_
*
* \verbatim PrüfeWertREGX: "MeinObjekt", "$Django" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyValueREGX( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Prüft den Standardwert eines Objektes (in den meisten Fällen ist dies der angezeigte Text).
* Der Sollwert wird als Wildcard-Match angegeben.
*
* Folgende Platzhalter sind möglich:
* * "?" - genau ein beliebiges Zeichen wird Maskiert
* * "*" - (0-n) beliebiges Zeichen wird Maskiert
* * "#" - genau eine Ziffer [0..9] kann maskiert werden
* _Beispiel: Prüfe, ob der Wert (Text) des Objekts "MeinObjekt" dem erwarteten
* Wert "\\.jango" entspricht:_
*
* \verbatim PrüfeWertWCM( "MeinObjekt", "$Django" ) \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert / Sollwert.
*
* \~english
* 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
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyValueWCM( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Copiert die gegebene Quelldatei zur Zieldatei
*
* In den Pfadangaben 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 kopiert worden sind.
* Falls die gegebene Quelldatei _nicht_ existiert, dann wird Fehlermeldung und eine Ausnahme augelöst und
* das Schlüsselwort/Tesfall beendet.
*
* \par Beispiel
* \code{.java}
* EN.CopyFile( "C:\temp\quellDatei.txt", "C:\temp\ZielDatei.txt" )
* \endcode
*
* \par Siehe auch
* - EN::CopyFile(String,String)
* - Core::CopyFile(String,String)
* - OK::CopyFile(String,String)
* - NOK::CopyFile(String,String)
* - OK_TRY::CopyFile(String,String)
* - NOK_TRY::CopyFile(String,String)
* - IOKW_State::CopyFile(String,String)
*
* @param fpsPathAndFileName Vollständiger Pfad und Dateiname.
*
* \~english
* Copies the given source files to the given destination.
*
* If the file does not exist, then this keyword ends with an error message and an exception will rais.
*
* - OKW-Parser is included.
* - widcards are in the filename allowed.
*
* @param fpsPathAndFileName Full path of teh File
*
* \~
* @author Zoltán Hrabovszki
* @date 2015.08.20
*/
void CopyFile( String fpsSourcePathAndFileName, String fpsDestinationPathAndFileName ) throws Exception;
/**
* \~german
* Legt das gegebene Verzeichniss an.
*
* Nachdem Ausführen des Schlüsselwortes ist die gegebene Datei vorhanden.
* -# Wenn die Datei existiert, dann passiert nicht weiter.
* -# Wenn die Datei nicht existiert, dann wird diese mit allen Eltern-Verzeichnissen angelegt.
*
* @param PATH Datei, welches angelegt werden soll.
*
* \~english
* Creates the given directory.
*
* After executing the keyword, the given file is exist.
* -# If the file exists, then does not happen further.
* -# If the file does not exist, it will be created with all parent directories.
*
* @param PATH File to be created.
* \~
* @author Zoltán Hrabovszki
* @date 2019-12-18
*/
void FileCreate( String PATH ) throws Exception;
/**
* \~german
* 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
* - EN::FileDelete(string)
* - Core::FileDelete(string)
* - OK::FileDelete(string)
* - NOK::FileDelete(string)
* - IOKW_State::FileDelete(string)
*
* @param fpsPathAndFileName Vollständiger Pfad und Dateiname.
*
* \~english
* 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.
*
* @param fpsPathAndFileName Full path of teh File
*
* \~
* @author Zoltán Hrabovszki
* @date 2015.08.20
*/
void FileDelete( String fpsPathAndFileName ) throws Exception;
/**
* \~german
* 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
* - EN::FileDelete(string)
* - Core::FileDelete(string)
* - OK::FileDelete(string)
* - NOK::FileDelete(string)
* - IOKW_State::FileDelete(string)
*
* @param fpsPathAndFileName Vollständiger Pfad und Dateiname.
*
* \~english
* 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.
*
* @param fpsPathAndFileName Full path of teh File
*
* \~
* @author Zoltán Hrabovszki
* @date 2019.12.16
*/
void FilesDelete( String fpsDirPath, String fpsFileMatch ) throws Exception;
/**
* \~german
* 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 Siehe auch
* - EN::DirectoryDelete(string)
* - Core::DirectoryDelete(string)
* - OK::DirectoryDelete(string)
* - NOK::DirectoryDelete(string)
* - IOKW_State::DirectoryDelete(string)
*
* @param PATH Vollständiger Pfad und Dateiname.
*
* \~english
* 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.
*
* \note
* This keyword ensures that _after_ execution, the specified file or files do not (no longer) exist.
* If the given file _not_ exists, _the keyword is terminated without an error message_ and an exception is raised.
*
*
* \par Siehe auch
* - EN::DirectoryDelete(string)
* - Core::DirectoryDelete(string)
* - OK::DirectoryDelete(string)
* - NOK::DirectoryDelete(string)
* - IOKW_State::DirectoryDelete(string)
*
* @param PATH Full path of th File
*
* \~
* @author Zoltán Hrabovszki
* @date 2019.12.01
*/
void DirectoryDelete( String PATH ) throws Exception;
/**
* \~german
* Legt das gegebene Verzeichniss an.
*
* Nachdem Ausführen des Schlüsselwortes ist das gegebene Verzeichniss vorhanden.
* -# wenn das Verzeichniss existiert, dann passiert nicht weiter.
* -# Wenn das Verzeichniss nicht existiert, dann wird diese mit allen Eltern-Verzeicnissen angelegt
*
* @param PATH Verzeichniss welches angelegt werden soll
*
* \~english
* Creates the given directory.
*
* After executing the keyword, the given directory is available.
* -# if the directory exists, then does not happen further.
* -# If the directory does not exist, it will be created with all parent directories.
*
* @param PATH Directory to be created
* \~
* @author Zoltán Hrabovszki
* @date 2019-12-01
*/
void DirectoryCreate( String PATH ) throws Exception;
/**
*\~german
* Prüft, ob die gegebene Datei existiert.
*
* @param fpsPathAndFileName Pfad und Name der Datei, die Geprüft werden soll
* @param 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
* Verifies that the given file exists.
*
* @param fpsPath Path and name of the file.
* @param ExpVal Expected Value. ExpVal: "YES"/"NO"/"${IGNORE}"
*
* \~
* @author [email protected]
* @date 2015-06-26
*/
void VerifyFileExists( String fpsPathAndFileName, String ExpVal ) throws Exception;
/**
*\~german
* Prüft, ob es sich bei dem gegebenen Pfad um eine Datei handelt.
*
* @param fpsPathAndFileName Pfad und Name der Datei, die geprüft werden soll.
* @param 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
* Checks whether the given path is a file.
*
* @param fpsPathAndFileName Path and name of the file to be checked.
* @param ExpVal Expected value. Possible values are: "YES"/"NO"/"${IGNORE}"
*
* \~
* @author [email protected]
* @date 2019-01-12
*/
void VerifyIsFile( String fpsPathAndFileName, String ExpVal ) throws Exception;
/**
* \~german
* Prüft, ob das gegebene Verzeichnis existiert.
*
* @param fpsPathA Pfad des Verzeichnisses, die Geprüft werden soll
* @param ExpVal Erwarteter Wert. Möglich Werte sind: "JA"/"NEIN"/"${IGNORIERE}"
*
* \~english
*
* @param fpsPathAndFileName Functional name of the object
* @param ExpVal Expected Value. ExpVal: "YES"/"NO"/"${IGNORE}"
*
* \~
* @author [email protected]
* @date 2015-06-26
*/
void VerifyDirectoryExists( String fpsPath, String ExpVal ) throws Exception;
/**
* \~german
* Checks the minimum number of characters that has to be entert.
*
* _Beispiel:_ Prüfe, ob min. 3 Zeichen in ein das Objekt mit FN = "Name"
* eingeben wurden:
*
* \verbatim EN.VerifyMinLength( "Name", "3" ) \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert, als String Zahl
*
* \~english
* Verifies the placeholder of a GUI-object.
*
* _Example:_ Check if min. 3 characters in the object with FN = "Name" have be inserted:
*
* \verbatim EN.VerifyMinLength( "Name", "3" ) \endverbatim
*
* @param FN Functional name of the object
* @param ExpVal Expected Value as String with Numbers
*
* \~
* @author Daniel Krüger
* @date 2019.06.18
*/
void VerifyMinLength( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft Fehlermeldungen in mit Angular validierten Formularen.
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Checks error messages in forms validated with Angular.
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author Daniel Krüger
* @date 2019-05-28
*/
void VerifyErrorMSG( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft Fehlermeldungen in mit Angular validierten Formularen.
* Der Sollwert wird als Wildcard-Match angegeben.
*
* Folgende Platzhalter sind möglich:
* * "?" - genau ein beliebiges Zeichen wird Maskiert
* * "*" - (0-n) beliebiges Zeichen wird Maskiert
* * "#" - genau eine Ziffer [0..9] kann maskiert werden
* _Beispiel: Prüfe, ob der Wert (Text) des Objekts "MeinObjekt" dem erwarteten
* Wert "\\.jango" entspricht:_
*
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Checks error messages in forms validated with Angular.
* The value is specified as a wildcard match.
*
* The following placeholders are possible:
* "?" - exactly one character is masked
* "*" - (0-n) any character is masked
* "#" - exactly one digit [0..9] can be masked
* Example: Check whether the value (text) of the object "MyObject" corresponds to the expected value.
* Value "\\\.jango" corresponds to:_
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyErrorMSG_WCM( String FN, String ExpVal ) throws Exception;
/**
* \~german
* Überprüft Fehlermeldungen in mit Angular validierten Formularen.
* Reguläre aus drücke als sollwert sind erlaubt.
*
* _Beispiel: Prüfe, ob der Wert (Text) des Objekts "MeinObjekt" dem erwarteten
* Wert "\\.jango" entspricht:_
*
* \verbatim PrüfeWertREGX: "MeinObjekt", "$Django" \endverbatim
*
* @param FN Funktionaler Name des Objekts
* @param ExpVal Erwarteter Wert
*
* \~english
* Regular expressions as setpoints are allowed.
* Checks error messages in forms validated with Angular.
* Example: Check whether the value (text) of the object "MyObject" corresponds to the expected value.
* Value "\\.jango" corresponds to:_
* \verbatim Checking VALUE REGX: "MyObject", "$Django" \endverbatim
*
* @param FN Functional name of the object
* @param ExpVal Expected Value
*
* \~
* @author [email protected]
* @date 2014-09-21
*/
void VerifyErrorMSG_REGX( String FN, String ExpVal ) throws Exception;
}