com.celequest.api.function
Interface IUDFunctionLogger

public interface IUDFunctionLogger

This interface is provided for implementors of user-defined functions to log messages.

Since:

2.5.3

Method Summary

boolean	isDebugEnabled() Returns true if logging at the DEBUG level is enabled for the com.celequest.functions.udf logger.
void	logDebug(String debugMessage) Logs a message using the com.celequest.functions.udf logger at the DEBUG level.
void	logError(String errorMessage) Logs a message using the com.celequest.functions.udf logger at the ERROR level.

Method Detail

logError

public void logError(String errorMessage)

Logs a message using the com.celequest.functions.udf logger at the ERROR level. This will appear in all log media set to log ERROR detail or higher. The detail level of the supported logging media can be controlled by the system administrator from the System Settings tab of the Administrative Console.

Parameters:

errorMessage - a localized message to be logged at ERROR level.

isDebugEnabled

public boolean isDebugEnabled()

Returns true if logging at the DEBUG level is enabled for the com.celequest.functions.udf logger. The detail level of the supported logging media can be controled by the system administrator from the System Settings tab of the Administrative Console.

To avoid unnecessary function calls and parameter construction, clients should check this value before logging at the debug level.

    if (_logger.isDebugEnabled())
    {
        _logger.logDebug(expensiveCallToGetLocalizedLogMessage(...));
    }
 

Returns:

true if debugging is enabled.

logDebug

public void logDebug(String debugMessage)

Logs a message using the com.celequest.functions.udf logger at the DEBUG level. This will appear in all log media set to log DEBUG detail or higher. The detail level of the supported logging media can be controlled by the system administrator from the System Settings tab of the Administrative Console.

Parameters:

debugMessage - a localized message to be logged at DEBUG level.