offapi/com/sun/star/logging/ConsoleHandler.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ConsoleHandler.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_logging_ConsoleHandler_idl__
  32 #define __com_sun_star_logging_ConsoleHandler_idl__
  33
  34 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #endif
  37 #ifndef __com_sun_star_beans_NamedValue_idl__
  38 #include <com/sun/star/beans/NamedValue.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module logging {
  44
  45 interface XConsoleHandler;
  46
  47 //=============================================================================
  48
  49 /** specifies a component implementing a log handler whose output
  50     channel is the processes console.
  51
  52     @since OOo 2.3
  53  */
  54 service ConsoleHandler : XConsoleHandler
  55 {
  56     /// creates a <code>ConsoleHandler</code>
  57     create();
  58
  59     /** creates an instance of the log handler, using generic settings
  60
  61         @param Settings
  62             contains the initial settings for the log handler
  63
  64             <p>The following settings are recognized and supported:
  65             <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li>
  66                 <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li>
  67                 <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li>
  68                 <li><code>Threshold</code> - denotes the initial value of the <member>XConsoleHandler::Threshold</member></li>
  69             </ul></p>
  70
  71         @throws ::com::sun::star::lang::IllegalArgumentException
  72             if <arg>Settings</args> contains arguments with names other than in the list above, or
  73             settings whose value is of the wrong type.
  74     */
  75     createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
  76         raises ( ::com::sun::star::lang::IllegalArgumentException );
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 //=============================================================================
  84
  85 #endif