udkapi/com/sun/star/lang/XInitialization.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: XInitialization.idl,v $
  10  * $Revision: 1.15 $
  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 #ifndef __com_sun_star_lang_XInitialization_idl__
  31 #define __com_sun_star_lang_XInitialization_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_uno_Exception_idl__
  38 #include <com/sun/star/uno/Exception.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module lang {
  45
  46 //=============================================================================
  47
  48 // DocMerge from xml: interface com::sun::star::lang::XInitialization
  49 /** initializes an object directly after its creation.
  50
  51     <p>This interface works together with factories. If you want to
  52     initialize the object after creation, you should
  53     support this interface and you may support other interfaces
  54     which offer type-safe initialization methods.  </p>
  55
  56     <p>Instead of calling <member>XSingleComponentFactory::createInstanceWithContext</member>
  57     and later initialize(), you should call
  58     <member>XSingleComponentFactory::createInstanceWithArgumentsAndContext</member>
  59     to pass the arguments to the instance. The reason is, that a component may want to
  60     return the same instance for the same set of parameters, and it can do so by implementing
  61     the factory itself.
  62     </p>
  63
  64  */
  65 published interface XInitialization: com::sun::star::uno::XInterface
  66 {
  67     //-------------------------------------------------------------------------
  68
  69     // DocMerge from xml: method com::sun::star::lang::XInitialization::initialize
  70     /** initializes the object.
  71
  72         <p>It should be called directly after the object is created.
  73      */
  74     void initialize( [in] sequence<any> aArguments )
  75             raises( com::sun::star::uno::Exception );
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 /*=============================================================================
  84
  85 =============================================================================*/
  86 #endif