Logger_Sngltn (OKW - OpenKeyWord 0.2.37 API)

java.lang.Object
- okw.log.Logger_Sngltn

All Implemented Interfaces:: ILogger

public class Logger_Sngltn
extends Object
implements ILogger

\~german

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLogger(ILogger fpLogger)` \~german \brief Fügt einen ILogger der Logger-Liste Logger.LoggerList \param fpLogger Logger, der \return \~english \brief \todo TODO: Brief Description.
`Boolean`	`getDebugMode()`
`static Logger_Sngltn`	`getInstance()` \~german Zentrale Logger-Klasse stellt Logger-Methoden innerhalb von OKW zur Verfügung.
`static void`	`init()`
`void`	`LogError(String fps_Message)` \brief LogError Function: Logs an error message to the results file.
`void`	`LogException(String fps_Message)` \brief LogException Function: Logs a Script Exception to the results file.
`void`	`LogKeyWordEnd()` LogKeyWordEnd: @todo TODO: Add description to LogKeyWordEnd \~
`void`	`LogKeyWordStart(String fpsKeyWordName, String... fpsParameter)` \~german \brief Ausgabe eines Schlüsselwortes \todo TODO: Ausführliche Beschreibung \param Parameterbezeichner \todo TODO: Beschreibung \return \~english \brief \todo TODO: Brief Description.
`void`	`LogLocalACCallEnd()` LogLocalACCallEnd: End of a local AC call.
`void`	`LogLocalACCallStart(String Gherkin, String Type)` LogLocalACCallStart: Start of a local AC call.
`void`	`LogPass(String fps_Message)` \brief LogPass: Logs an passes-message to the result.
`void`	`LogPrint(String fps_Message)` \brief LogPrint Function: Prints the values of expressions to the results file.
`void`	`LogPrintDebug(String fpsMessage)` \~german \brief Loggt eine Nachricht Die Nachricht fpsMessage wird im Ergebniss ausgegeben.
`void`	`LogRemoteACCallEnd()` LogRemoteACCallEnd: End of a remote AC call.
`void`	`LogRemoteACCallStart(String Gherkin, String Type)` LogRemoteACCallStart: Start of a remote AC call.
`void`	`LogSequenceEnd()` LogSequenceEnd: @todo TODO: Add description to LogSequenceEnd.
`void`	`LogSequenceStart(String fpsKeyWordName, String fpsWinowFN, String fpsSequenceName, String... fpsParameter)` LogSequenceStart: Begin of a Sequence.
`void`	`LogSourceLocation(String Start, String End, String featureName, String sourceType)` \brief LogWarning Function: Logs a warning to the results file.
`void`	`LogStepEnd()` LogStepEnd: Log End of (Test) Step.
`void`	`LogStepStart(String categoryName, String categoryType, String choiceValue, String featureName, String localCategoryName, String sourceExcerpt, String type)` LogStepStart: Log Begin of (Test) Step.
`void`	`LogTestcaseEnd()` LogTestcaseEnd: @todo TODO: Add description to LogTestcaseEnd \~
`void`	`LogTestcaseStart(String fps_TestcaseName)` \~german \brief Ausgabe des Testfalls \todo TODO: Ausführliche Beschreibung \param Parameterbezeichner \todo TODO: Beschreibung \return \~english \brief \todo TODO: Brief Description.
`void`	`LogVersionTxt()` \~german Logt den Versions-Text beim Start eines Skriptes.
`void`	`LogWarning(String fps_Message)` \brief LogWarning Function: Logs a warning to the results file.
`void`	`ResCloseList()` \brief Closes a hierarchical level in the results file that was opened with ResOpenList.
`void`	`ResCloseListDebug()` \brief Closes a hierarchical level in the results file that was opened with ResOpenList.
`void`	`reset()` \~german \brief Initialisi.
`void`	`ResOpenList(String fps_Name)` \brief Creates a new hierarchical level in the results file.
`void`	`ResOpenListDebug(String fpsListCaption)` \~german \brief Erzeugt eine hierachische Log-Ebene in der Ergenbniss-Ausgabe.
`void`	`setDebugMode(Boolean fpbDebugMode)` setDebugMode: @todo TODO: Add description to setDebugMode.

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

- Method Detail
  - getDebugMode
```
public Boolean getDebugMode()
```
  - setDebugMode
```
public void setDebugMode(Boolean fpbDebugMode)
```
    Description copied from interface: ILogger
    
    setDebugMode: @todo TODO: Add description to setDebugMode.
    
    Specified by:
    
    setDebugMode in interface ILogger
    
    Parameters:
    
    fpbDebugMode - If true the DebugMode ist on. Else if false the DebugMode is off. \~
  - getInstance
```
public static Logger_Sngltn getInstance()
```
    \~german Zentrale Logger-Klasse stellt Logger-Methoden innerhalb von OKW zur Verfügung. \~english Central Log-Classes offers the Logging-Methodes.
  - init
```
public static void init()
```
  - LogVersionTxt
```
public void LogVersionTxt()
```
    \~german Logt den Versions-Text beim Start eines Skriptes. Die Information wird aus der Resourcen-Datei "okw/version.txt" gelesen und mit Logger_Sngltn geloggt. \~english Logs the version text when starting a script. The information is read from the resource file "okw/version.txt" and logged with Logger_Sngltn. \~
  - addLogger
```
public void addLogger(ILogger fpLogger)
```
    \~german \brief Fügt einen ILogger der Logger-Liste Logger.LoggerList \param fpLogger Logger, der \return \~english \brief \todo TODO: Brief Description. \todo TODO: Detailed Description \param fpbTrueOrFalse \return \~ \author Zoltán Hrabovszki \date 2015.05.01
  - reset
```
public void reset()
```
    \~german \brief Initialisi. \~english \brief \todo TODO: Brief Description. \todo TODO: Detailed Description \~
    
    Specified by:
    
    reset in interface ILogger
  - LogError
```
public void LogError(String fps_Message)
```
    \brief LogError Function: Logs an error message to the results file. \param fps_Message
    
    Specified by:
    
    LogError in interface ILogger
  - LogException
```
public void LogException(String fps_Message)
```
    \brief LogException Function: Logs a Script Exception to the results file. \param fps_Message
    
    Specified by:
    
    LogException in interface ILogger
    
    Parameters:
    
    fps_Message - \~
  - LogKeyWordEnd
```
public void LogKeyWordEnd()
```
    Description copied from interface: ILogger
    
    LogKeyWordEnd: @todo TODO: Add description to LogKeyWordEnd \~
    
    Specified by:
    
    LogKeyWordEnd in interface ILogger
  - LogStepStart
```
public void LogStepStart(String categoryName,
                         String categoryType,
                         String choiceValue,
                         String featureName,
                         String localCategoryName,
                         String sourceExcerpt,
                         String type)
```
    Description copied from interface: ILogger
    
    LogStepStart: Log Begin of (Test) Step. This log is for [Harmony](https://cloud.4test.io/).
    
    Specified by:
    
    LogStepStart in interface ILogger
  - LogStepEnd
```
public void LogStepEnd()
```
    Description copied from interface: ILogger
    
    LogStepEnd: Log End of (Test) Step. This log is for [Harmony](https://cloud.4test.io/). \~
    
    Specified by:
    
    LogStepEnd in interface ILogger
  - LogLocalACCallStart
```
public void LogLocalACCallStart(String Gherkin,
                                String Type)
```
    Description copied from interface: ILogger
    
    LogLocalACCallStart: Start of a local AC call. This log is for [Harmony](https://cloud.4test.io/).
    
    Specified by:
    
    LogLocalACCallStart in interface ILogger
  - LogLocalACCallEnd
```
public void LogLocalACCallEnd()
```
    Description copied from interface: ILogger
    
    LogLocalACCallEnd: End of a local AC call. This log is for [Harmony](https://cloud.4test.io/). \~
    
    Specified by:
    
    LogLocalACCallEnd in interface ILogger
  - LogRemoteACCallStart
```
public void LogRemoteACCallStart(String Gherkin,
                                 String Type)
```
    Description copied from interface: ILogger
    
    LogRemoteACCallStart: Start of a remote AC call. This log is for [Harmony](https://cloud.4test.io/).
    
    Specified by:
    
    LogRemoteACCallStart in interface ILogger
  - LogRemoteACCallEnd
```
public void LogRemoteACCallEnd()
```
    Description copied from interface: ILogger
    
    LogRemoteACCallEnd: End of a remote AC call. This log is for [Harmony](https://cloud.4test.io/). \~
    
    Specified by:
    
    LogRemoteACCallEnd in interface ILogger
  - LogSequenceEnd
```
public void LogSequenceEnd()
```
    Description copied from interface: ILogger
    
    LogSequenceEnd: @todo TODO: Add description to LogSequenceEnd. \~
    
    Specified by:
    
    LogSequenceEnd in interface ILogger
  - LogTestcaseEnd
```
public void LogTestcaseEnd()
```
    Description copied from interface: ILogger
    
    LogTestcaseEnd: @todo TODO: Add description to LogTestcaseEnd \~
    
    Specified by:
    
    LogTestcaseEnd in interface ILogger
  - LogKeyWordStart
```
public void LogKeyWordStart(String fpsKeyWordName,
                            String... fpsParameter)
```
    \~german \brief Ausgabe eines Schlüsselwortes \todo TODO: Ausführliche Beschreibung \param Parameterbezeichner \todo TODO: Beschreibung \return \~english \brief \todo TODO: Brief Description. \todo TODO: Detailed Description \param fpbTrueOrFalse \return \~ \author Zoltán Hrabovszki \date 2015.05.01
    
    Specified by:
    
    LogKeyWordStart in interface ILogger
    
    fpsParameter - \~
  - LogSequenceStart
```
public void LogSequenceStart(String fpsKeyWordName,
                             String fpsWinowFN,
                             String fpsSequenceName,
                             String... fpsParameter)
```
    Description copied from interface: ILogger
    
    LogSequenceStart: Begin of a Sequence. This log is used by the Sequence-keyword.
    
    Specified by:
    
    LogSequenceStart in interface ILogger
    
    Parameters:
    
    fpsKeyWordName - In this case "Sequence" - language depended Log e.g. "Sequenz" in german.
    
    fpsWinowFN - Funktionalname of the Window.
    
    fpsSequenceName - Name of the Sequence of the given Window.
    
    fpsParameter - Optional Parameter of the Sequence \~
  - LogTestcaseStart
```
public void LogTestcaseStart(String fps_TestcaseName)
```
    \~german \brief Ausgabe des Testfalls \todo TODO: Ausführliche Beschreibung \param Parameterbezeichner \todo TODO: Beschreibung \return \~english \brief \todo TODO: Brief Description. \todo TODO: Detailed Description \param fpbTrueOrFalse \return \~ \author Zoltán Hrabovszki \date 2015.05.01
    
    Specified by:
    
    LogTestcaseStart in interface ILogger
    
    Parameters:
    
    fps_TestcaseName - \~
  - LogPass
```
public void LogPass(String fps_Message)
```
    \brief LogPass: Logs an passes-message to the result. \param fps_Message
    
    Specified by:
    
    LogPass in interface ILogger
    
    Parameters:
    
    fps_Message - Pass message \~
  - LogPrint
```
public void LogPrint(String fps_Message)
```
    \brief LogPrint Function: Prints the values of expressions to the results file. \param fps_Message
    
    Specified by:
    
    LogPrint in interface ILogger
    
    Parameters:
    
    fps_Message - Message to print. \~
  - LogPrintDebug
```
public void LogPrintDebug(String fpsMessage)
```
    \~german \brief Loggt eine Nachricht Die Nachricht fpsMessage wird im Ergebniss ausgegeben. \param fpsMessage Nachricht, die Ausgegeben werden soll. \~english \brief \todo TODO: Brief sescription. \todo TODO: Detailed Description \param fpsMessage \return \~ \author Zoltán Hrabovszki \date 2015.05.01 \brief Prints the message fps_Messageof expressions to the results file, if cvb_DebugMode \param fps_Message Message to Print
    
    Specified by:
    
    LogPrintDebug in interface ILogger
    
    Parameters:
    
    fpsMessage - \~
  - LogWarning
```
public void LogWarning(String fps_Message)
```
    \brief LogWarning Function: Logs a warning to the results file. \param fps_Message
    
    Specified by:
    
    LogWarning in interface ILogger
    
    Parameters:
    
    fps_Message - Warning message. \~
  - LogSourceLocation
```
public void LogSourceLocation(String Start,
                              String End,
                              String featureName,
                              String sourceType)
```
    \brief LogWarning Function: Logs a warning to the results file. \param fps_Message
    
    Specified by:
    
    LogSourceLocation in interface ILogger
    
    Parameters:
    
    Start - of the Source
    
    End - of the Source
    
    featureName - the name of feature like "Main Menu"
    
    sourceType - The Type of the "ac" \~
  - ResCloseList
```
public void ResCloseList()
```
    \brief Closes a hierarchical level in the results file that was opened with ResOpenList. Use ResOpenList to start a new hierarchical level. The Print commands that follow it are indented until you close the level with ResCloseList. When you view the results file, the item sName is initially collapsed, indicated by the [+] icon next to it. You can expand sName to reveal the indented items under it.
    
    Specified by:
    
    ResCloseList in interface ILogger
  - ResCloseListDebug
```
public void ResCloseListDebug()
```
    \brief Closes a hierarchical level in the results file that was opened with ResOpenList. Use ResOpenList to start a new hierarchical level. The Print commands that follow it are indented until you close the level with ResCloseList. When you view the results file, the item sName is initially collapsed, indicated by the [+] icon next to it. You can expand sName to reveal the indented items under it.
    
    Specified by:
    
    ResCloseListDebug in interface ILogger
  - ResOpenList
```
public void ResOpenList(String fps_Name)
```
    \brief Creates a new hierarchical level in the results file. Use ResOpenList to start a new hierarchical level. The Print commands that follow it are indented until you close the level with ResCloseList. When you view the results file, the item sName is initially collapsed, indicated by the [+] icon next to it. You can expand sName to reveal the indented items under it. \param fps_Name
    
    Specified by:
    
    ResOpenList in interface ILogger
  - ResOpenListDebug
```
public void ResOpenListDebug(String fpsListCaption)
```
    \~german \brief Erzeugt eine hierachische Log-Ebene in der Ergenbniss-Ausgabe. \todo TODO: Ausführliche Beschreibung erstellen. \param fpsListCaption Überschrift der Log-Ebene. \~english \brief Creates a new hierarchical level in the results file. Use ResOpenList to start a new hierarchical level. The Print commands that follow it are indented until you close the level with ResCloseList. When you view the results file, the item sName is initially collapsed, indicated by the [+] icon next to it. You can expand sName to reveal the indented items under it. \param fpsListCaption Caption of the resultlist. \~ \author Zoltán Hrabovszki \date 2015.05.01
    
    Specified by:
    
    ResOpenListDebug in interface ILogger
    
    Parameters:
    
    fpsListCaption - Überschrift neu zuöffnenden Liste \~english Opens a new result list leven with the geven header.

Class Logger_Sngltn

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDebugMode

setDebugMode

getInstance

init

LogVersionTxt

addLogger

reset

LogError

LogException

LogKeyWordEnd

LogStepStart

LogStepEnd

LogLocalACCallStart

LogLocalACCallEnd

LogRemoteACCallStart

LogRemoteACCallEnd

LogSequenceEnd

LogTestcaseEnd

LogKeyWordStart

LogSequenceStart

LogTestcaseStart

LogPass

LogPrint

LogPrintDebug

LogWarning

LogSourceLocation

ResCloseList

ResCloseListDebug

ResOpenList

ResOpenListDebug