loggable.java

jbpm的demo,带有流程设计

/*
 * $Source: /home/ws/rz65/CVS-Repository/WorkflowProjects/JBPM-Demo/src/java/jbpmdemo/logging/Loggable.java,v $
 * $Revision: 1.1 $
 * $Date: 2005/03/05 12:16:28 $
 * $Author: rz65 $
 *
 * Copyright (c) 2005 Universitaet Karlsruhe (TH) / Rechenzentrum (RZ-UNI-UKA)
 *
 * RZ-UNI-KA makes no representations or warranties about the suitability
 * of this software, either express or implied, including but not limited
 * to the implied warranties of merchantability, fitness for a particular
 * purpose, or non-infringement. RZ-UNI-KA shall not be liable for any
 * damages as a result of using, modifying or distributing this software
 * or its derivatives.
 */

package jbpmdemo.logging;

import jbpmdemo.logging.LoggingConstants;

import org.apache.commons.logging.Log;

/**
 * This interface provides methods for objects. Basically, it interface extends
 * the <a href="http://jakarta.apache.org/commons/logging/"> Apache Commons
 * Logging Interface </a>. The interface uses <a
 * href="http://logging.apache.org/"> Log4J </a> as underlying logging
 * framework.
 * 
 * <p>
 * 
 * {@link Loggable}inherits the standard logging methods (e.g.
 * <code>info(...)</code> or <code>debug(...)</code>) from the Commons
 * Logging Interface. Additionally, it overloads these methods by a method that
 * expects an extra String argument that is used to specify the name of the
 * method that issued a logging event.
 * 
 * <p>
 * 
 * OSWFDemo provides a base class {@link LoggableObject}that implements
 * {@link Loggable}. This base class can be used as a replacement for
 * {@link Object}in your class hierarchy in order to provide logging
 * capabilities. If your classes are already strapped to a given hierarchy,
 * logging might be provided by delegation. For details, see the
 * {@link LoggableObject}description.
 * 
 * <p>
 * 
 * @version $Revision: 1.1 $
 * @author mailto:[e-mail]
 */

public interface Loggable extends Log, LoggingConstants {

	/**
	 * <p>
	 * Is debug logging currently enabled?
	 * </p>
	 * 
	 * <p>
	 * Call this method to prevent having to perform expensive operations (for
	 * example, <code>String</code> concatination) when the log level is more
	 * than debug.
	 * </p>
	 */
	public boolean isDebugEnabled();

	/**
	 * <p>
	 * Is error logging currently enabled?
	 * </p>
	 * 
	 * <p>
	 * Call this method to prevent having to perform expensive operations (for
	 * example, <code>String</code> concatination) when the log level is more
	 * than error.
	 * </p>
	 */
	public boolean isErrorEnabled();

	/**
	 * <p>
	 * Is fatal logging currently enabled?
	 * </p>
	 * 
	 * <p>
	 * Call this method to prevent having to perform expensive operations (for
	 * example, <code>String</code> concatination) when the log level is more
	 * than fatal.
	 * </p>
	 */
	public boolean isFatalEnabled();

	/**
	 * <p>
	 * Is info logging currently enabled?
	 * </p>
	 * 
	 * <p>
	 * Call this method to prevent having to perform expensive operations (for
	 * example, <code>String</code> concatination) when the log level is more
	 * than info.
	 * </p>
	 */
	public boolean isInfoEnabled();

	/**
	 * <p>
	 * Is trace logging currently enabled?
	 * </p>
	 * 
	 * <p>
	 * Call this method to prevent having to perform expensive operations (for
	 * example, <code>String</code> concatination) when the log level is more
	 * than trace.
	 * </p>
	 */
	public boolean isTraceEnabled();

	/**
	 * <p>
	 * Is warning logging currently enabled?
	 * </p>
	 * 
	 * <p>
	 * Call this method to prevent having to perform expensive operations (for
	 * example, <code>String</code> concatination) when the log level is more
	 * than warning.
	 * </p>
	 */
	public boolean isWarnEnabled();

	/**
	 * <p>
	 * Log a message with trace log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 */
	public void trace(String methodName, Object message);

	/**
	 * <p>
	 * Log an error with trace log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 * @param throwable
	 *            The cause for this message.
	 */
	public void trace(String methodName, Object message, Throwable throwable);

	/**
	 * <p>
	 * Log a message with debug log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 */
	public void debug(String methodName, Object message);

	/**
	 * <p>
	 * Log an error with debug log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 * @param throwable
	 *            The cause for this message.
	 */
	public void debug(String methodName, Object message, Throwable throwable);

	/**
	 * <p>
	 * Log a message with info log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 */
	public void info(String methodName, Object message);

	/**
	 * <p>
	 * Log an error with info log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 * @param throwable
	 *            The cause for this message.
	 */
	public void info(String methodName, Object message, Throwable throwable);

	/**
	 * <p>
	 * Log a message with warn log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 */
	public void warn(String methodName, Object message);

	/**
	 * <p>
	 * Log an error with warn log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 * @param throwable
	 *            The cause for this message.
	 */
	public void warn(String methodName, Object message, Throwable throwable);

	/**
	 * <p>
	 * Log a message with error log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 */
	public void error(String methodName, Object message);

	/**
	 * <p>
	 * Log an error with error log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 * @param throwable
	 *            The cause for this message.
	 */
	public void error(String methodName, Object message, Throwable throwable);

	/**
	 * <p>
	 * Log a message with fatal log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 */
	public void fatal(String methodName, Object message);

	/**
	 * <p>
	 * Log an error with fatal log level.
	 * </p>
	 * 
	 * @param methodName
	 *            The name of the method that issued this message.
	 * @param message
	 *            The log message.
	 * @param throwable
	 *            The cause for this message.
	 */
	public void fatal(String methodName, Object message, Throwable throwable);
}