offapi/com/sun/star/logging/FileHandler.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: FileHandler.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_FileHandler_idl__
  32 #define __com_sun_star_logging_FileHandler_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 XLogHandler;
  46
  47 //=============================================================================
  48
  49 /** specifies a component implementing a log handler whose output
  50     channel is a file.
  51
  52     <p>The handler will use the <code>Encoding</code> attribute of <type>XLogHandler</type>
  53     to determine how to encode strings before actually writing them to the output
  54     file.</p>
  55
  56     @see XLogHandler::Encoding
  57
  58     @since OOo 2.3
  59  */
  60 service FileHandler : XLogHandler
  61 {
  62     /** creates a log handler whose output is directed to a file given by URL.
  63
  64         @param FileURL
  65             the URL of the file to be created. This URL is resolved using the
  66             <type scope="::com::sun::star::util">PathSubstitution</type> service. That
  67             is, it is allowed to include placeholders such as <code>$(userurl)</code>.
  68     */
  69     create( [in] string FileURL );
  70
  71     /** creates an instance of the log handler, using generic settings
  72
  73         @param Settings
  74             contains the initial settings for the log handler
  75
  76             <p>The following settings are recognized and supported:
  77             <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li>
  78                 <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li>
  79                 <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li>
  80             </ul></p>
  81
  82             <p>Additionally, a setting name <code>FileURL</code> is recognized. It must be of type
  83             string, and denotes the file URL to which the handler's output should be directed.</p>
  84
  85             <p>At least the URL argument must be present in the settings.</p>
  86
  87         @throws ::com::sun::star::lang::IllegalArgumentException
  88             if <arg>Settings</args> contains settings whose value is of the wrong type.
  89     */
  90     createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
  91         raises ( ::com::sun::star::lang::IllegalArgumentException );
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 //=============================================================================
  99
 100 #endif