org.safs.tools.logs

Interface UniqueMessageInterface

All Superinterfaces:

UniqueIDInterface

All Known Implementing Classes:

UniqueStringMessageInfo

public interface UniqueMessageInterface
extends UniqueIDInterface

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLogMessage() The message to log.
java.lang.String	getLogMessageDescription() Optional.
int	getLogMessageType() The type of the message to log.

Methods inherited from interface org.safs.tools.UniqueIDInterface

getUniqueID

Method Detail

getLogMessage

java.lang.String getLogMessage()

The message to log.

getLogMessageDescription

java.lang.String getLogMessageDescription()

Optional. Additional details associated with the message. In many logs, this appears as an additional descriptive line in log output. This may be null or an empty string, and should be ignored if it is such.

getLogMessageType

int getLogMessageType()

The type of the message to log. For example, a GENERIC message, a PASSED message, a FAILED message, etc.. This may be implementation specific.