oracle.dss.util.xdo.common.log
Interface XDOLog

All Superinterfaces:

XDOLogConstants

All Known Implementing Classes:

XDOLogImpl

public interface XDOLog
extends XDOLogConstants

This class XDOLog is an interface to the logging core implementation.

See Also:

XDOLogImpl, oracle.apps.xdo.oa.util.OAXDOLogImpl, Logger

Field Summary

static java.lang.String

RCS_ID

Fields inherited from interface oracle.dss.util.xdo.common.log.XDOLogConstants

ERROR, EVENT, EXCEPTION, OFF, PROCEDURE, STATEMENT, UNEXPECTED

Method Summary

boolean	isEnabled(int pLevel) Checks whether logging is enabled for this level.
void	setLevel(int pLevel) Set the logging level.
void	setModule(java.lang.String pModule) Sets the class/package for which logging should be turned on.
void	write(java.lang.Object pThis, java.lang.String pString, int pLevel) Write a log.
void	write(java.lang.String pString, int pLevel) Write a log.

Field Detail

RCS_ID

static final java.lang.String RCS_ID

See Also:

Constant Field Values

Method Detail

setLevel

void setLevel(int pLevel)

Set the logging level. It can use one of the 7 values:

• UNEXPECTED
• ERROR
• EXCEPTION
• EVENT
• PROCEDURE
• STATEMENT
• OFF

The levels are listed in descending order of severity. Only log messages which have a level greater than or equal to the set value will be displayed.

When you set the value to 'OFF', no log info will be displayed.

Parameters:

pLevel - System logging level

setModule

void setModule(java.lang.String pModule)

Sets the class/package for which logging should be turned on. Only log messages which belong to the same module will be displayed. In its internal, it does the forward matching with the absolute class name of the object passed by write() method. For example, if you pass "java.io" to this method, the log mesasges occurred in "java.io.InputStream" or "java.io.Writer" will be logged. If you pass If you pass "all", it will log everything.

The default is "all".

Parameters:

pModule - Module name to be logged

write

void write(java.lang.Object pThis,
           java.lang.String pString,
           int pLevel)

Write a log.

Logging message will be like;

 [component][logging level] log message text
 [component][logging level] log message text
 [component][logging level] log message text
 [component][logging level] log message text
 [component][logging level] log message text
 

Usually you can pass "this" for the first parameter to log in order to specify the current object in the log.

Parameters:

pThis - Current object

pString - Log message

pLevel - Logging level

write

void write(java.lang.String pString,
           int pLevel)

Write a log. This message will be logged regardless of the module setting by setModule() method.

Parameters:

pString - Log message

pLevel - Logging level

See Also:

write(Object, String, int), setModule(String)

isEnabled

boolean isEnabled(int pLevel)

Checks whether logging is enabled for this level. For performance reasons, User must check this before constructing any new Objects for logging.

Parameters:

pLevel - the level of the message

Returns:

true if logging is enabled for pLevel false if logging is not.