
// Copyright (c) 2000 Oracle Corporation
package oracle.portal.provider.v1;

/**
 * A Class class.
 * <P>
 * @author Michael Freedman
 */
public interface ProviderLog  {

    /**
     *
     * Writes the specified message to a provider log, which is usually
     * an event log. The message provides explanatory information about
     * an exception or error or an action the provider takes. The name
     * and type of the provider log file is specific to the provider engine.
     *
     *
     * @param msg 	a <code>String</code> specifying the explanatory
     *			message to be written to the log file
     *
     */

    public void log(String msg);

    /**
     * Writes the stack trace and an explanatory message
     * for a given <code>Throwable</code> exception
     * to the provider log file. The stack trace is
     * part of the <code>Throwable</code> object, and
     * the message is the one you specify in the <code>message</code>
     * parameter. The name and type of the provider log file is specific to
     * the provider engine, but it is usually an event log.
     *
     *
     * @param message 		a <code>String</code> that
     *				describes the error or exception
     *
     * @param throwable 	the <code>Throwable</code> error
     *				or exception
     *
     */

    public void log(String message, Throwable throwable);
}

