okw.log

Interface ILogger

All Known Implementing Classes:

Log2Console, Logger_Sngltn

public interface ILogger

Debug Logs are not a part of Interface. This methods are implemented in Logger.cs a Log*Debug function calls after checking the log-conditions(debug=true) the Log*-Funktion(without "Debug") void LogPrintDebug(); \~

Author:

Zoltan Hrabovszki \date 2016-10-23

Method Summary

Modifier and Type	Method and Description
void	LogError(String Message) LogError: Logs an error message to the result.
void	LogException(String Message) LogException: Logs an exception to the results.
void	LogKeyWordEnd() LogKeyWordEnd: @todo TODO: Add description to LogKeyWordEnd \~
void	LogKeyWordStart(String KeyWordName, String... Params) LogKeyWordStart: @todo TODO: Add description to LogKeyWordStart
void	LogLocalACCallEnd() LogLocalACCallEnd: End of a local AC call.
void	LogLocalACCallStart(String sourceExcerpt, String Type) LogLocalACCallStart: Start of a local AC call.
void	LogPass(String Message) LogPass: Logs an error message to the result.
void	LogPrint(String Message) LogPrint: Prints the given message to the results.
void	LogPrintDebug(String Message) LogPrintDebug: @todo TODO: Add description to LogPrintDebug.
void	LogRemoteACCallEnd() LogRemoteACCallEnd: End of a remote AC call.
void	LogRemoteACCallStart(String sourceExcerpt, String Type) LogRemoteACCallStart: Start of a remote AC call.
void	LogSequenceEnd() LogSequenceEnd: @todo TODO: Add description to LogSequenceEnd.
void	LogSequenceStart(String KeyWordName, String FN, String SEQName, String... Params) LogSequenceStart: Begin of a Sequence.
void	LogSourceLocation(String Start, String End, String featureName, String sourceType) LogSourceLocation: Logs location of Source in Harmony.
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 fpsTestcaseName) LogTestcaseStart: @todo TODO: Add description to LogTestcaseStart
void	LogWarning(String Message) LogWarning: Logs an error message to the result.
void	ResCloseList() ResCloseList: Closes the outline level.
void	ResCloseListDebug() ResCloseListDebug: @todo TODO: Add description to ResCloseListDebug.
void	reset() Method resets .
void	ResOpenList(String ListHeader) LogFunctionStartDebug: Opens a debug outline level with the .
void	ResOpenListDebug(String ListHeader) \~german Öffnet eine neue debug Ergenis-Ebene mit der gegebenen Überschrift.
void	setDebugMode(Boolean fpbDebugMode) setDebugMode: @todo TODO: Add description to setDebugMode.

Method Detail

reset

void reset()

Method resets . \~

LogError

void LogError(String Message)

LogError: Logs an error message to the result. @todo TODO: Add description.

Parameters:

fps_Message - Error message text. \~

LogPass

void LogPass(String Message)

LogPass: Logs an error message to the result. @todo TODO: Add description.

Parameters:

Message - Pass message \~

LogWarning

void LogWarning(String Message)

LogWarning: Logs an error message to the result. @todo TODO: Add description.

Parameters:

Message - Warning message. \~

LogException

void LogException(String Message)

LogException: Logs an exception to the results.

Parameters:

Message - \~

LogSourceLocation

void LogSourceLocation(String Start,
                       String End,
                       String featureName,
                       String sourceType)

LogSourceLocation: Logs location of Source in Harmony. This is a special log for [Harmony](https://cloud.4test.io/). Holds the Referenz to the Source in Harmony to create a Hyperlink from Report to the source of Teststep. This log is only used for Harmoy.

Parameters:

Start - of the Source

End - of the Source

featureName - the name of feature like "Main Menu"

sourceType - The Type of the "ac" \~

LogPrint

void LogPrint(String Message)

LogPrint: Prints the given message to the results.

Parameters:

Message - Message to print. \~

LogPrintDebug

void LogPrintDebug(String Message)

LogPrintDebug: @todo TODO: Add description to LogPrintDebug.

Parameters:

Message - \~

LogTestcaseStart

void LogTestcaseStart(String fpsTestcaseName)

LogTestcaseStart: @todo TODO: Add description to LogTestcaseStart

Parameters:

fpsTestcaseName - \~

LogTestcaseEnd

void LogTestcaseEnd()

LogTestcaseEnd: @todo TODO: Add description to LogTestcaseEnd \~

LogKeyWordStart

void LogKeyWordStart(String KeyWordName,
                     String... Params)

LogKeyWordStart: @todo TODO: Add description to LogKeyWordStart

Parameters:

KeyWordName -

Params - \~

LogKeyWordEnd

void LogKeyWordEnd()

LogKeyWordEnd: @todo TODO: Add description to LogKeyWordEnd \~

LogStepStart

void LogStepStart(String categoryName,
                  String categoryType,
                  String choiceValue,
                  String featureName,
                  String localCategoryName,
                  String sourceExcerpt,
                  String type)

LogStepStart: Log Begin of (Test) Step. This log is for [Harmony](https://cloud.4test.io/).

Parameters:

Gherkin - Gherkin expression. \~

LogStepEnd

void LogStepEnd()

LogStepEnd: Log End of (Test) Step. This log is for [Harmony](https://cloud.4test.io/). \~

LogLocalACCallStart

void LogLocalACCallStart(String sourceExcerpt,
                         String Type)

LogLocalACCallStart: Start of a local AC call. This log is for [Harmony](https://cloud.4test.io/).

Parameters:

Gherkin - Gherkin expression. \~

LogLocalACCallEnd

void LogLocalACCallEnd()

LogLocalACCallEnd: End of a local AC call. This log is for [Harmony](https://cloud.4test.io/). \~

LogRemoteACCallStart

void LogRemoteACCallStart(String sourceExcerpt,
                          String Type)

LogRemoteACCallStart: Start of a remote AC call. This log is for [Harmony](https://cloud.4test.io/).

Parameters:

Gherkin - Gherkin expression. \~

LogRemoteACCallEnd

void LogRemoteACCallEnd()

LogRemoteACCallEnd: End of a remote AC call. This log is for [Harmony](https://cloud.4test.io/). \~

LogSequenceStart

void LogSequenceStart(String KeyWordName,
                      String FN,
                      String SEQName,
                      String... Params)

LogSequenceStart: Begin of a Sequence. This log is used by the Sequence-keyword.

Parameters:

KeyWordName - In this case "Sequence" - language depended Log e.g. "Sequenz" in german.

FN - Funktionalname of the Window.

SEQName - Name of the Sequence of the given Window.

Params - Optional Parameter of the Sequence \~

LogSequenceEnd

void LogSequenceEnd()

LogSequenceEnd: @todo TODO: Add description to LogSequenceEnd. \~

ResOpenList

void ResOpenList(String ListHeader)

LogFunctionStartDebug: Opens a debug outline level with the .

Parameters:

LevelHeader - \~

ResOpenListDebug

void ResOpenListDebug(String ListHeader)

\~german Öffnet eine neue debug Ergenis-Ebene mit der gegebenen Überschrift.

Parameters:

ListHeader - Überschrift neu zuöffnenden Liste \~english Opens a new result list leven with the geven header.

ListHeader - \~

ResCloseList

void ResCloseList()

ResCloseList: Closes the outline level.

Parameters:

fps_Message -

fpsParameter - \~

ResCloseListDebug

void ResCloseListDebug()

ResCloseListDebug: @todo TODO: Add description to ResCloseListDebug. \~

setDebugMode

void setDebugMode(Boolean fpbDebugMode)

setDebugMode: @todo TODO: Add description to setDebugMode.

Parameters:

fpbDebugMode - If true the DebugMode ist on. Else if false the DebugMode is off. \~