View Javadoc

1   /*
2    * This file is part of Domingo
3    * an Open Source Java-API to Lotus Notes/Domino
4    * hosted at http://domingo.sourceforge.net
5    *
6    * Copyright (c) 2003-2007 Beck et al. projects GmbH Munich, Germany (http://www.bea.de)
7    *
8    * This library is free software; you can redistribute it and/or
9    * modify it under the terms of the GNU Lesser General Public
10   * License as published by the Free Software Foundation; either
11   * version 2.1 of the License, or (at your option) any later version.
12   *
13   * This library is distributed in the hope that it will be useful,
14   * but WITHOUT ANY WARRANTY; without even the implied warranty of
15   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   * Lesser General Public License for more details.
17   *
18   * You should have received a copy of the GNU Lesser General Public
19   * License along with this library; if not, write to the Free Software
20   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21   */
22  
23  package de.bea.domingo;
24  
25  /***
26   * Enables you to record actions and errors that take place during
27   * a program's execution. You can record actions and errors in.
28   * <p><ul>
29   * <li>A Domino database</li>
30   * <li>A mail memo</li>
31   * <li>A file (for programs that run locally)</li>
32   * <li>An agent log (for agents)</li>
33   * </ul></p>
34   *
35   * @author <a href="mailto:kriede@users.sourceforge.net">Kurt Riede</a>
36   */
37  public interface DLog extends DBase {
38  
39      /***
40       * Opens a notes database as the log target.
41       *
42       * @param server notes server name
43       * @param database notes database filename
44       */
45      void openNotesLog(String server, String database);
46  
47      /***
48       * Records an error in a log.
49       *
50       * @param code a number indicating which error occurred.
51       * @param text a description of the error that occurred, as you want it to appear in the log.
52       */
53      void logError(int code, String text);
54  
55      /***
56       * Records an action in a log.
57       *
58       * @param text a description of the action, as you want it to appear in the log.
59       */
60      void logAction(String text);
61  }